mirror of
https://github.com/kataras/iris.git
synced 2025-12-26 22:37:08 +00:00
This commit is contained in:
55
.github/CONTRIBUTING.md
vendored
Normal file
55
.github/CONTRIBUTING.md
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
## 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 - 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 - 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 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
|
||||
|
||||
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?
|
||||
|
||||
[Chat]: https://kataras.rocket.chat/channel/iris
|
||||
Reference in New Issue
Block a user