go-packages/iris
1
0
Fork 0
mirror of https://github.com/kataras/iris.git synced 2025-01-23 02:31:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add a contributing section

Browse Source
This commit is contained in:
Makis Maropoulos 2016-06-25 05:54:52 +03:00
parent 5cf18b264e
commit 3145b20ba2
2 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
CONTRIBUTING.md Normal file
View File

@ -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).

6
README.md
View File

@ -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
------------