Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (59 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

94 lines (59 loc) · 2.69 KB

Contributing

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/omenapps/django-model-info/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Implement Features

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

Write Documentation

django-model-info could always use more documentation, whether as part of the official django-model-info docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/omenapps/django-model-info/issues.

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.
  • Remember that this is a volunteer-driven project, and that contributions are welcome.

Get Started!

Ready to contribute? Here's how to set up django-model-info for local development.

  1. Fork the django-model-info repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/django-model-info.git

  3. Install uv and set up your local development environment:

    $ cd django-model-info/
$ uv sync --group dev

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass linting and the tests:

    $ uv run nox -s pre-commit
$ uv run pytest -vv

    To run the full test matrix across Python and Django versions:

    $ uv run nox -s tests

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.11-3.14. CI will verify this automatically.