mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 18:51:03 +01:00
39 lines
2.3 KiB
Markdown
39 lines
2.3 KiB
Markdown
## 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.
|
|
|
|
Second, [Star](https://github.com/kataras/iris/stargazers) & [Watch](https://github.com/kataras/iris/watchers) the Iris repo, I'm working very hard for this project, I need a confirmation that this project is used by someone else except myself.
|
|
|
|
|
|
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 - 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).
|
|
|
|
|
|
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).
|