Skip to content

Commit 2ae8971

Browse files
author
Paul Hallett
committed
Add Makefile and better CONTRIBUTING.md
1 parent 090ce6e commit 2ae8971

File tree

4 files changed

+39
-22
lines changed

4 files changed

+39
-22
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Thanks for helping to make graphene-django great!
4+
5+
We welcome all kinds of contributions:
6+
7+
- Bug fixes
8+
- Documentation improvements
9+
- New features
10+
- Refactoring & tidying
11+
12+
13+
## Getting started
14+
15+
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.
16+
17+
18+
## Project setup
19+
20+
After cloning this repo, ensure dependencies are installed by running:
21+
22+
```sh
23+
make dev-setup
24+
```
25+
26+
## Running tests
27+
28+
After developing, the full test suite can be evaluated by running:
29+
30+
```sh
31+
make tests
32+
```

Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
dev-setup:
2+
pip install -e ".[test]"
3+
4+
tests:
5+
py.test graphene_django --cov=graphene_django -vv

README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,7 @@ To learn more check out the following [examples](examples/):
9696

9797
## Contributing
9898

99-
After cloning this repo, ensure dependencies are installed by running:
100-
101-
```sh
102-
pip install -e ".[test]"
103-
```
104-
105-
After developing, the full test suite can be evaluated by running:
106-
107-
```sh
108-
py.test graphene_django --cov=graphene_django # Use -v -s for verbose mode
109-
```
99+
See [CONTRIBUTING.md](contributing.md)
110100

111101

112102
### Documentation

README.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -105,17 +105,7 @@ To learn more check out the following `examples <examples/>`__:
105105
Contributing
106106
------------
107107

108-
After cloning this repo, ensure dependencies are installed by running:
109-
110-
.. code:: sh
111-
112-
pip install -e ".[test]"
113-
114-
After developing, the full test suite can be evaluated by running:
115-
116-
.. code:: sh
117-
118-
py.test graphene_django --cov=graphene_django # Use -v -s for verbose mode
108+
See `CONTRIBUTING.md <CONTRIBUTING.md>`__.
119109

120110
Documentation
121111
~~~~~~~~~~~~~

0 commit comments

Comments
 (0)