From 9534ff49bb1e754499f18278743d4174e7737436 Mon Sep 17 00:00:00 2001 From: Juan Ignacio Fiorentino Date: Tue, 10 Apr 2018 22:04:24 -0300 Subject: [PATCH] Edit README and contribute doc. --- README.md | 14 ++------------ docs/sections/contribute.rst | 11 +++++++---- 2 files changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0aafd1a..6223d9a 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,5 @@ OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol, whic Support for Python 3 and 2. Also latest versions of django. -[Read docs for more info](http://django-oidc-provider.readthedocs.org/). - -## Contributing - -[Join us!](https://github.com/juanifioren/django-oidc-provider/graphs/contributors) we love contributions, so please feel free to fix bugs, improve things, provide documentation. You SHOULD follow this steps: - -* Fork the project and create new branch from `develop`. -* Make your feature addition or bug fix. -* Add tests for it inside `oidc_provider/tests`. Then run all and ensure everything is OK (read docs for how to test in all envs). -* Create an issue and explain your changes. -* Create pull request for the issue to the `develop` branch. -* Wait for the collaborators to review it. +[Read documentation for more info.](http://django-oidc-provider.readthedocs.org/) +[Do you want to contribute? Please read this.](http://django-oidc-provider.readthedocs.io/en/latest/sections/contribute.html) diff --git a/docs/sections/contribute.rst b/docs/sections/contribute.rst index db10819..e67769c 100644 --- a/docs/sections/contribute.rst +++ b/docs/sections/contribute.rst @@ -3,12 +3,15 @@ Contribute ########## -We love contributions, so please feel free to fix bugs, improve things, provide documentation. You SHOULD follow this steps: +We love contributions, so please feel free to fix bugs, improve things, provide documentation. These are the steps: -* Fork the project. +* Create an issue and explain your feature/bugfix. +* Wait collaborators comments. +* Fork the project and create new branch from `develop`. * Make your feature addition or bug fix. -* Add tests for it inside ``oidc_provider/tests``. Then run all tests and ensure everything is OK (see the section below on how to test in all envs). -* Send pull request to the specific version branch. +* Add tests and documentation if needed. +* Create pull request for the issue to the `develop` branch. +* Wait collaborators reviews. Running Tests =============