diff --git a/GUIDELINES.md b/GUIDELINES.md index e69de29..2bb6eb3 100644 --- a/GUIDELINES.md +++ b/GUIDELINES.md @@ -0,0 +1,24 @@ +# Contributor Guidlines + +## Maintainers: +Following are the users with write-access to this repository (maintainers) : +* @bstriner +* @farizrahman4u +* @fchollet +* @kemaswill +* @lukedeo +* @patyork +* @tboquet +* @the-moliver + +## Addition of new features +* Addition of new features require submitting a pull request, even for those who have write access to this repository. +* All incoming new features should be accompanied by documentation and unit tests. + +## Becoming a maintainer +* To become a maintainer, you should be a recognized contributor to either Keras-contrib or Keras core. +* If you think you are eligible to be a maintainer, you can contact one of the existing maintainers to join the team. + +## Versioning +* Keras-contrib is tested only against the bleeding-edge version of Keras. +* In case the Travis build fails due to a change in Keras core, the maintainers are responsible of rectifying the issue. diff --git a/README.md b/README.md index 12c2f80..b65d5cd 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,5 @@ Alternatively, using pip: ```shell sudo pip install git+https://www.github.com/farizrahman4u/keras-contrib.git ``` + +For contributor guidelines see [GUIDELINES.md](GUIDELINES.md)