Development

---

We love contributions from everyone. Don't be afraid to open a new Pull Request on GitHub.

Support Questions

Don't use the GitHub's Issue tracker for general Python and Flask related questions. For FlaskBB it is ok for now. #python and Stack Overflow is also worth considering for asking support questions.

Reporting Issues

Please provide as many details as possible. This will make it easier for us to figure out what went wrong.

Contributing Code

FlaskBB uses uv to manage dependencies and run everything below. Once uv is installed, uv sync in the project root sets up a working dev environment - no separate requirements file to install from.

Format and lint your code with ruff before submitting:

make format

Then run the testsuite with pytest:

make test

Both make targets are thin wrappers around uv run ruff ... / uv run pytest; run those directly if you'd rather not use make.

Mention how your changes affect the project to other developers and users in the CHANGES file.

Push to your fork. Write a good commit message. Submit a pull request.

Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.