We appreciate both issues and pull requests that you submit for this project. We do first ask that you ensure that you are using this gem correctly by following the instructions in the README.md file.
Feel free to create issues of any kind, all issues are appreciated. Typically a collaborator of this project will involve themselves with issues to ensure that the issues align with the direction of the project.
When reporting a bug, please attach the error stack trace along with any other contextual information. Try to describe the bug and the situation in which the bug occurred, we want to be able to reproduce it in another environment. For example, in the situation where you are using specific data (i.e., a specific repository) do include that information.
If you have a potential idea or feature you would like to see. Please let us know about it in an issue. Mention what you envision as well as a potential use case for why this feature might be worth developing.
If you are submitting a pull requests we recommend the following process:
- Fork the main repository
- Create a topic branch (
git checkout -b my-new-feature) - Make changes in your forked repository's topic branch
- Make some commit
- If you wish for this topic branch to eventually proceed into the main repository, create a pull requests as soon as possible
- Continue to work on your topic branch, which is now exposed on the main repository (for further discussion with collaborators)
- Complete your topic branch's feature or fix
- Make sure you write green specs. Your pull request will not be merged until there are passing specs.
- Signify that you are completed in the pull requests
- At least one of the repository collaborators will sign off (i.e., with a thumbs up) that your changes are good to merge
- Your pull requests is accepted into the main repository's master branch