kumi/django-oidc-provider
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Edit README and contribute doc.

Browse source
This commit is contained in:
Juan Ignacio Fiorentino 2018-04-10 22:04:24 -03:00
parent 9b7be87dad
commit 9534ff49bb
2 changed files with 9 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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)

11
docs/sections/contribute.rst
View file

@ -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
=============