Add Makefile and better CONTRIBUTING.md

This commit is contained in:
Paul Hallett 2019-04-26 13:14:28 +01:00
parent 090ce6e1f1
commit 2ae897187c
No known key found for this signature in database
GPG Key ID: 529C11F0C93CDF11
4 changed files with 39 additions and 22 deletions

32
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,32 @@
# 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
```

5
Makefile Normal file
View File

@ -0,0 +1,5 @@
dev-setup:
pip install -e ".[test]"
tests:
py.test graphene_django --cov=graphene_django -vv

View File

@ -96,17 +96,7 @@ To learn more check out the following [examples](examples/):
## Contributing ## Contributing
After cloning this repo, ensure dependencies are installed by running: See [CONTRIBUTING.md](contributing.md)
```sh
pip install -e ".[test]"
```
After developing, the full test suite can be evaluated by running:
```sh
py.test graphene_django --cov=graphene_django # Use -v -s for verbose mode
```
### Documentation ### Documentation

View File

@ -105,17 +105,7 @@ To learn more check out the following `examples <examples/>`__:
Contributing Contributing
------------ ------------
After cloning this repo, ensure dependencies are installed by running: See `CONTRIBUTING.md <CONTRIBUTING.md>`__.
.. code:: sh
pip install -e ".[test]"
After developing, the full test suite can be evaluated by running:
.. code:: sh
py.test graphene_django --cov=graphene_django # Use -v -s for verbose mode
Documentation Documentation
~~~~~~~~~~~~~ ~~~~~~~~~~~~~