Contributing

If you would like to contribute to django-environ, please take a look at the current issues <https://github.com/joke2k/django-environ/issues>_. If there is a bug or feature that you want but it isn't listed, make an issue and work on it.

Bug reports

Before raising an issue, please ensure that you are using the latest version of django-environ.

Please provide the following information with your issue to enable us to respond as quickly as possible.

• The relevant versions of the packages you are using.
• The steps to recreate your issue.
• The full stacktrace if there is an exception.
• An executable code example where possible

Guidelines for bug reports:

• Use the GitHub issue search — check if the issue has already been reported.
• Check if the issue has been fixed — try to reproduce it using the latest main or develop branch in the repository.
• Isolate the problem — create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Local setup quick start

For a quick local setup and test run:

1. Create and activate a virtual environment:

   .. code-block:: bash

   python3 -m venv .venv . .venv/bin/activate

2. Install development dependencies:

   .. code-block:: bash

   python -m pip install -U pip tox tox-gh-actions setuptools

3. Run the test suite (or one environment while iterating):

   .. code-block:: bash

   tox tox -e py312-django51

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Follow this process if you'd like your work considered for inclusion in the project:

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository <https://github.com/joke2k/django-environ>_ on GitHub and create your topic branch from develop.
3. Open your pull request against develop.
4. main is the stable/release branch and is updated from develop by maintainers as part of the release flow.
5. Write a test which shows that the bug was fixed or that the feature works as expected.
6. Send a pull request and bug the maintainer until it gets merged and published.

If you are intending to implement a fairly large feature we'd appreciate if you open an issue with GitHub detailing your use case and intended solution to discuss how it might impact other work that is in flight.

We also appreciate it if you take the time to update and write tests for any changes you submit.

By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.

Resources

• How to Contribute to Open Source <https://opensource.guide/how-to-contribute/>_
• Using Pull Requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>_
• Writing good commit messages <https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>_