Skip to content

Latest commit

 

History

History
211 lines (140 loc) · 6.8 KB

CONTRIBUTING.rst

File metadata and controls

211 lines (140 loc) · 6.8 KB

How to contribute to Flask-SQLAlchemy

Thank you for considering contributing to Flask-SQLAlchemy!

Support questions

Please don't use the issue tracker for this. The issue tracker is a tool to address bugs and feature requests in Flask-SQLAlchemy itself. Use one of the following resources for questions about using Flask-SQLAlchemy or issues with your own code:

Reporting issues

Flask-SQLAlchemy is a thin wrapper that combines Flask and SQLAlchemy. Make sure your issue is actually with Flask-SQLAlchemy and not SQLAlchemy before submitting it. Check the traceback to see if the error is coming from SQLAlchemy. Check if your issue has already been reported to SQLAlchemy.

Include the following information in your post:

  • Describe what you expected to happen.
  • If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python, Flask-SQLAlchemy, and SQLAlchemy versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.

Submitting patches

If there is not an open issue for what you want to submit, prefer opening one for discussion before working on a PR. You can work on any issue that doesn't have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. No need to ask if you can work on an issue that interests you.

Include the following in your patch:

  • Use Black to format your code. This and other tools will run automatically if you install pre-commit using the instructions below.
  • All code and docs should be wrapped at 88 characters.
  • Include tests if your patch adds or changes code. Make sure the test fails without your patch.
  • Update any relevant docs pages and docstrings.
  • Add an entry in CHANGES.rst. Use the same style as other entries. Also include .. versionchanged:: inline changelogs in relevant docstrings.

First time setup

  • Download and install the latest version of git.

  • Configure git with your username and email.

    $ git config --global user.name 'your name'
$ git config --global user.email 'your email'

  • Make sure you have a GitHub account.

  • Fork Flask-SQLAlchemy to your GitHub account by clicking the Fork button.

  • Clone the main repository locally.

    $ git clone https://github.com/pallets-eco/flask-sqlalchemy
$ cd flask-sqlalchemy

  • Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote "fork", the default Pallets remote is "origin".

    git remote add fork https://github.com/{username}/flask-sqlalchemy

  • Install PDM, the tool we use to manage the development environment.

  • Use PDM to set up the development environment. This automatically creates a virtualenv, installs development tools, and installs the project in editable mode.

    $ pdm sync

  • Install the pre-commit hooks.

    $ pdm run pre-commit install

Start coding

  • Create a branch to identify the issue you would like to work on. If you're submitting a bug or documentation fix, branch off of the latest ".x" branch.

    $ git fetch origin
$ git checkout -b your-branch-name origin/3.0.x

    If you're submitting a feature addition or change, branch off of the "main" branch.

    $ git fetch origin
$ git checkout -b your-branch-name origin/main

  • Using your favorite editor, make your changes, committing as you go.

  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests as described below.

  • Push your commits to your fork on GitHub and create a pull request. Link to the issue being addressed with fixes #123 in the pull request.

    $ git push --set-upstream fork your-branch-name

Running the tests

Run the basic test suite with pytest.

$ pdm run pytest

This runs the tests for the current environment, which is usually sufficient. CI will run the full suite when you submit your pull request. You can run the full test suite in parallel with tox if you don't want to wait.

$ pdm run tox -p

Running test coverage

Generating a report of lines that do not have test coverage can indicate where to start contributing. Collect coverage from the tests and generate a report.

$ pdm run pytest --cov
$ pdm run coverage html

Open htmlcov/index.html in your browser to explore the report.

Read more about coverage.

Building the docs

Build the docs in the docs directory using Sphinx.

$ cd docs
$ make html

Open _build/html/index.html in your browser to view the docs.

Read more about Sphinx.