CONTRIBUTING.md
# Contributing to RouteTranslator
Looking to contribute something to RouteTranslator? **Here's how you can help.**
## Reporting issues
We only accept issues that are bug reports or feature requests. Bugs must be isolated and reproducible problems that we can fix within the RouteTranslator core. Please read the following guidelines before opening any issue.
1. **Search for existing issues.**
2. **Create an isolated and reproducible test case.**
3. **Include a live example if possible.**
4. **Share as much information as possible.** Include at least Rails version and gem version. Also include steps to reproduce the bug.
A [Bug Request Template](https://github.com/enriclluelles/route_translator/issues/new?assignees=&labels=bug%2Cneeds-triage&projects=&template=bug_report.yml&title=Bug%3A+) will
guide you in the creation of a good bug report.
## Key branches
- `master` is the latest, deployed version.
- `develop` is the official development branch for the next release.
Take a look at [git-flow, A successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model/)
## Pull requests
- If your PR fixes bugs or documentation, pull against the `master` branch
- If your PR includes new features, pull against the `develop` branch
- Try not to pollute your pull request with unintended changes--keep them simple and small
- **Test.** If you find a bug, write at first a failing test case and then fix it.
- We are open to discussion. If you have troubles or questions, feel free to start a new issue
## Coding standards
### Ruby
- [Ruby Styleguide](https://github.com/rubocop/ruby-style-guide)
### Commits
- [How to Write a Git Commit Message](https://cbea.ms/git-commit/#seven-rules)
## License
By contributing your code, you agree to license your contribution under the terms of the [MIT License](LICENSE)