From 2ae897187cec9119de3753bc646e806b69487188 Mon Sep 17 00:00:00 2001 From: Paul Hallett Date: Fri, 26 Apr 2019 13:14:28 +0100 Subject: [PATCH 1/2] Add Makefile and better CONTRIBUTING.md --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ Makefile | 5 +++++ README.md | 12 +----------- README.rst | 12 +----------- 4 files changed, 39 insertions(+), 22 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 Makefile diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9731c03 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 +``` \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5c174ac --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +dev-setup: + pip install -e ".[test]" + +tests: + py.test graphene_django --cov=graphene_django -vv \ No newline at end of file diff --git a/README.md b/README.md index ef3f40c..9b8916a 100644 --- a/README.md +++ b/README.md @@ -96,17 +96,7 @@ To learn more check out the following [examples](examples/): ## Contributing -After cloning this repo, ensure dependencies are installed by running: - -```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 -``` +See [CONTRIBUTING.md](contributing.md) ### Documentation diff --git a/README.rst b/README.rst index a96e60f..e884a40 100644 --- a/README.rst +++ b/README.rst @@ -105,17 +105,7 @@ To learn more check out the following `examples `__: Contributing ------------ -After cloning this repo, ensure dependencies are installed by running: - -.. 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 +See `CONTRIBUTING.md `__. Documentation ~~~~~~~~~~~~~ From bba8377a8209235fadb07848e11429c2d18aeff4 Mon Sep 17 00:00:00 2001 From: Paul Hallett Date: Fri, 26 Apr 2019 14:08:44 +0100 Subject: [PATCH 2/2] Move documentation to CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ README.md | 20 +------------------- README.rst | 19 ------------------- 3 files changed, 18 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9731c03..4a650d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,4 +29,21 @@ After developing, the full test suite can be evaluated by running: ```sh make tests +``` + +## 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 ``` \ No newline at end of file diff --git a/README.md b/README.md index 9b8916a..fffa1d3 100644 --- a/README.md +++ b/README.md @@ -96,22 +96,4 @@ To learn more check out the following [examples](examples/): ## Contributing -See [CONTRIBUTING.md](contributing.md) - - -### 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 -``` +See [CONTRIBUTING.md](contributing.md) \ No newline at end of file diff --git a/README.rst b/README.rst index e884a40..2e0593d 100644 --- a/README.rst +++ b/README.rst @@ -107,25 +107,6 @@ Contributing See `CONTRIBUTING.md `__. -Documentation -~~~~~~~~~~~~~ - -The `documentation `__ is generated using the excellent -`Sphinx `__ and a custom theme. - -The documentation dependencies are installed by running: - -.. code:: sh - - cd docs - pip install -r requirements.txt - -Then to produce a HTML version of the documentation: - -.. code:: sh - - make html - .. |Graphene Logo| image:: http://graphene-python.org/favicon.png .. |Build Status| image:: https://travis-ci.org/graphql-python/graphene-django.svg?branch=master :target: https://travis-ci.org/graphql-python/graphene-django