.github/CONTRIBUTING.md
# Contributing to ClarifaiRuby
Thank you for being interested in contributing to the wonderful world of Open Source!
The following is a set of guidelines for contributing to the ClarifaiRuby gem.
This is **not** for contributing to Clarifai's API but just how the wrapper
is built and supports developer's interaction with Clarifai's API. As mentioned
before, these are simply guidelines, **not rules**, use your best judgement and feel
free to submit pull requests to even improve this document to helping future
contributors.
## How can I Contribute?
### Reporting Bugs
This section guides you through submitting a bug report for ClarifaiRuby. Following
these guidelines helps maintainers and the community understand your report, reproduce
the behavior, and find related reports.
Before creating bug reports, please check the issues tab and see if your problem isn't already
mentioned or potentially being worked on already as you may not need to create an issue.
When you are creating a bug report, please include as many details as possible.
If you'd like, you can use this template to structure the information.
#### Template for Bug Reports
```
[Short description of problem here]
**Reproduction Steps:**
1. [First Step]
2. [Second Step]
3. [Other Steps...]
**Expected behavior:**
[Describe expected behavior here]
**Observed behavior:**
[Describe observed behavior here]
**Screenshots and GIFs**
![Screenshots and GIFs which follow reproduction steps to demonstrate the problem](url)
<!-- Feel free to doodle over current screenshots to illustrate what the addition is as well! -->
```
### Suggested Enhancements
This section guides you through submitting an enhancement suggestion for ClarifaiRuby,
including completely new features and minor improvements to existing functionality.
Following these guidelines helps maintainers and the community understand your
suggestion and find related suggestions.
Before creating enhancement suggestions, please check the issues and pull request tabs
to see if your enhancement is not already being worked on or if you find that your
suggestion is already mentioned. When you are creating an enhancement suggestion,
please include as many details as possible. If you'd like, you can use this template
to structure the information.
#### Template for Enhancements
```
[Short description of suggestion]
[Describe current and suggested behavior here]
**Why would the enhancement be useful to most users**
[Explain why the enhancement would be useful to most users]
**Screenshots and GIFs**
![Screenshots and GIFs which demonstrate the steps or part of ClarifaiRuby the enhancement suggestion is related to](url)
<!-- Feel free to doodle over current screenshots to illustrate what the addition is as well! -->
```
## Styleguides
The ClarifaiRuby gem follows the [Ruby Community Style Guide](https://github.com/bbatsov/ruby-style-guide).
For any contribution, please be sure to follow this guide as well to keep the repository consistent with other gems.
## Additional Notes
**EMPTY**