From 3145b20ba20fa23150c7e24fdc90f1ccce7044fb Mon Sep 17 00:00:00 2001 From: Makis Maropoulos Date: Sat, 25 Jun 2016 05:54:52 +0300 Subject: [PATCH] Add a contributing section --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 6 +++++- 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..fefdbcd6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +## Contributing Issues + +### Before Submitting an Issue +First, please do a search in open issues to see if the issue or feature request has already been filed. If there is an issue add your comments to this issue. + +The Iris project is distributed across multiple repositories, try to file the issue against the correct repository, + +- [Iris - core](https://github.com/kataras/iris) +- [Iris - gitbook](https://github.com/iris-contrib/gitbook) +- [Iris - examples](https://github.com/iris-contrib/examples) +- [Iris - tests](https://github.com/iris-contrib/tests) +- [Iris - middleware](https://github.com/iris-contrib/middleware) +- [Iris - plugin](https://github.com/iris-contrib/plugin) +- [Iris - graceful](https://github.com/iris-contrib/graceful) +- [Iris - mail](https://github.com/iris-contrib/mail). + + +If your issue is a question then please ask the question on [Gitter](https://gitter.im/kataras/iris). + +## Writing Good Bug Reports and Feature Requests + +File a single issue per problem and feature request, do not file combo issues. + +The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. Therefore: + +* Provide reproducable steps, what the result of the steps was, and what you would have expected. +* Description of what you expect to happen +* Animated GIFs +* Code that demonstrates the issue +* Version of Iris +* Errors in the Terminal/Console +* When you have glide/godep installed, can you reproduce the issue when starting Iris' station without these? + +## Contributing Fixes +If you are interested in fixing issues and contributing directly to the Iris base, please see the document [How to Contribute](https://github.com/iris-contrib/wiki/blob/master/How-to-Contribute.md). diff --git a/README.md b/README.md index 60af743c..462744cc 100644 --- a/README.md +++ b/README.md @@ -174,11 +174,15 @@ If you're willing to donate click [here](DONATIONS.md)! People ------------ -A big thanks goes to [all people](https://github.com/kataras/iris/issues?utf8=%E2%9C%93&q=label%3A%22feature+request%22) who help building this framework with feature-requests, bug reports and more! +A big thanks goes to [all people](https://github.com/kataras/iris/issues?utf8=%E2%9C%93&q=label%3A%22feature+request%22) who help building this framework with feature-requests & bug reports! The author of Iris is [@kataras](https://github.com/kataras). +Contributing +------------ +If you are interested in contributing to the Iris project, please see the document [CONTRIBUTING](https://github.com/kataras/iris/blob/master/CONTRIBUTING.md). + License ------------