iris/CONTRIBUTING.md

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
• Iris - gitbook
• Iris - examples
• Iris - tests
• Iris - middleware
• Iris - plugin
• Iris - graceful
• Iris - mail.

If your issue is a question then please ask the question on 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?

Contributing Fixes

If you are interested in fixing issues and contributing directly to the Iris base, please see the document How to Contribute.