From c792acc999258d0189a0a142308fdcd3acfcee0d Mon Sep 17 00:00:00 2001 From: Gerasimos Maropoulos Date: Mon, 26 Sep 2016 10:46:58 +0300 Subject: [PATCH] Read this before post a new issue, please --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a52e7647..64549538 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,42 @@ -## Contributing Issues +## Before Submitting an Issue -### 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/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) +- [Iris - cli and rizla]((https://github.com/kataras/rizla/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) +- [Iris - templates](https://github.com/kataras/go-template/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) +- [Iris - sessions](https://github.com/kataras/go-sessions/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) +- [Iris - websocket](https://github.com/kataras/go-websocket/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) - [Iris - gitbook](https://github.com/iris-contrib/gitbook/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) - [Iris - examples](https://github.com/iris-contrib/examples/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) -- [Iris - tests](https://github.com/iris-contrib/tests/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) - [Iris - middleware](https://github.com/iris-contrib/middleware/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) - [Iris - plugin](https://github.com/iris-contrib/plugin/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) - [Iris - graceful](https://github.com/iris-contrib/graceful/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) - [Iris - mail](https://github.com/iris-contrib/mail/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue). +- [Iris - core](https://github.com/kataras/iris/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue) + +Before post a new issue do an iris upgrade: + +- Delete `$GOPATH/src/github.com/kataras` +- Open shell and execute the command: `go get -u github.com/kataras/iris/iris` +- Try to re-produce the issue +- If the issue still exists, then post the issue with the necessary information. -If your issue is a question then please ask the question on [community chat][Chat]. + +If the issue is after an upgrade, please read the [HISTORY.md](https://github.com/kataras/iris/blob/master/HISTORY.md) for any breaking-changes and fixes. + +The author answers the same day, perhaps the same hour you post the issue. + +It is impossible to notify each user on every change, so to be aware of the framework's changes and be notify about updates +please **star** or **watch** the repository. + + + + +If your issue is a closed-personal question then please ask that question on [community chat][Chat]. + ## Writing Good Bug Reports and Feature Requests @@ -31,9 +52,4 @@ The more information you can provide, the more likely someone will be successful * 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). - [Chat]: https://kataras.rocket.chat/channel/iris -[ChatMain]: https://kataras.rocket.chat/channel/iris -[ChatAlternative]: https://gitter.im/kataras/iris