mirror of
https://github.com/graphql-python/graphene-django.git
synced 2024-11-10 19:57:15 +03:00
4517e32224
* 🔧 Add pre-commit config Similar to graphene and graphene-sqlalchemy * ⬆ Bump black * 👷 Lint on CI * ⬆ Bump flake8-black * 🔧 Keep excluding migrations * ⬆ Bump flake8 * 🔧 Remove black and flake8 from tox config * ⬆ Update pre-commit versions * Upgrade syntax to python 3.7+ * Format with pre-commit dedent docs/schema.py to allow formatting * Fix tests on python 3.7
63 lines
1.3 KiB
Markdown
63 lines
1.3 KiB
Markdown
# 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](https://github.com/graphql-python/graphene-django/issues) and [projects](https://github.com/graphql-python/graphene-django/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:
|
|
|
|
```sh
|
|
make dev-setup
|
|
```
|
|
|
|
## Running tests
|
|
|
|
After developing, the full test suite can be evaluated by running:
|
|
|
|
```sh
|
|
make tests
|
|
```
|
|
|
|
## Opening Pull Requests
|
|
|
|
Please fork the project and open a pull request against the master branch.
|
|
|
|
This will trigger a series of test and lint checks.
|
|
|
|
We advise that you format and run lint locally before doing this to save time:
|
|
|
|
```sh
|
|
make format
|
|
make lint
|
|
```
|
|
|
|
## Documentation
|
|
|
|
The [documentation](http://docs.graphene-python.org/projects/django/en/latest/) is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
|
|
|
|
The documentation dependencies are installed by running:
|
|
|
|
```sh
|
|
cd docs
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
Then to produce a HTML version of the documentation:
|
|
|
|
```sh
|
|
make html
|
|
```
|