Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.05 KB

CONTRIBUTING.rst

File metadata and controls

72 lines (45 loc) · 2.05 KB
Raw

Contributing

Thanks for your interest in contributing! The advice below will help you get your issue fixed / pull request merged.

Please file bugs and send pull requests to the GitHub repository and issue tracker.

Submitting Issues

Issues are easier to reproduce/resolve when they have:

  • A pull request with a failing test demonstrating the issue
  • A code example that produces the issue consistently
  • A traceback (when applicable)

Pull Requests

When creating a pull request:

  • Write tests (see below)
  • Note user-facing changes in the CHANGES file
  • Update the documentation as needed
  • Add yourself to the AUTHORS file

Testing

Please add tests for any changes you submit. The tests should fail before your code changes, and pass with your changes. Existing tests should not break. Coverage (see below) should remain at 100% following a full tox run.

To install all the requirements for running the tests:

pip install -r requirements.txt

The tests also require that you have a local PostgreSQL server running and a user with create-database permissions. The tests will use a database named djftest; if it already exists it will be wiped and re-created.

To run the tests once:

./runtests.py

To run tox (which runs the tests across all supported Python and Django versions) and generate a coverage report in the htmlcov/ directory:

make test

This requires that you have python3.8, python3.9, python3.10, and python3.11 binaries on your system's shell path.

To install PostgreSQL on Debian-based systems:

$ sudo apt-get install postgresql

You'll need to run the tests as a user with permission to create databases. By default, the tests attempt to connect as a user with your shell username. You can override this by setting the environment variable DJF_USERNAME.