We love pull requests from everyone. By participating in this project, you agree to abide by the Blues Inc code of conduct.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by writing or editing documentation
- by writing specifications
- by writing code ( no patch is too small : fix typos, add comments, clean up inconsistent whitespace )
- by refactoring code
- by closing issues
- by reviewing patches
- We use the GitHub issue tracker to track bugs and features.
- Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
- When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your release version, stack, and operating system. Ideally, a bug report should include a pull request with failing specs.
- Issues that have no response from the submitter will be closed after 30 days.
- Issues will be closed once they're assumed to be fixed or answered. If the maintainer is wrong, it can be opened again.
- If your issue is closed by mistake, please understand and explain the issue. We will happily reopen the issue.
- Fork the official repository.
- Create a topic branch.
- Implement your feature or bug fix.
- Add, commit, and push your changes. Please try to use conventional commits when pushing changes - this will ensure better changelog documentation when the next release is cut.
- Submit a pull request with a conventional commit title.
NOTE: Examples of many of the conventional commit types accepted are visible in the
publish-npm.yml
file under theGenerate release changelog
step.
In addition to the following guidelines, please follow the conventions already established in the code.
Relevant articles:
Inspired by https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md