Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.76 KB

CONTRIBUTING.rst

File metadata and controls

63 lines (39 loc) · 1.76 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Get Started!

Types of Contributions

You can contribute in many ways:

Report Bugs

Report bugs in the issue section of the repository on GitHub.

If you are reporting a bug, please include:

  • Detailed steps to reproduce the bug.
  • Any details about your local setup that might be helpful in troubleshooting.

Fix Bugs

Look through the issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

We could always use more documentation, whether as part of the docs or in docstrings in the code.

Submit Feedback

The best way to send feedback is to file an issue on GitHub.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Set up your environment

  1. Fork the upstream django-auth-adfs repository into a personal account.
  2. Install poetry running pip install poetry or curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
  3. Configure poetry to create a virtual environment in your project folder: poetry config virtualenvs.in-project true
  1. Install dependencies by running poetry install
  2. Create a new branch for your changes
  3. Push the topic branch to your personal fork
  4. Create a pull request to the django-auth-adfs repository with a detailed explanation