graphene-django/CONTRIBUTING.md
2019-04-26 14:08:44 +01:00

1.1 KiB

Contributing

Thanks for helping to make graphene-django great!

We welcome all kinds of contributions:

  • Bug fixes
  • Documentation improvements
  • New features
  • Refactoring & tidying

Getting started

If you have a specific contribution in mind, be sure to check the issues and projects in progress - someone could already be working on something similar and you can help out.

Project setup

After cloning this repo, ensure dependencies are installed by running:

make dev-setup

Running tests

After developing, the full test suite can be evaluated by running:

make tests

Documentation

The documentation is generated using the excellent Sphinx and a custom theme.

The documentation dependencies are installed by running:

cd docs
pip install -r requirements.txt

Then to produce a HTML version of the documentation:

make html