Guard::RubyCritic is open source and contributions from the community are encouraged! No contribution is too small. Please consider:
If you want to squash a bug or add a new feature, please:
-
Fork the project.
-
Create a feature branch (
git checkout -b my-new-feature). -
Make your changes. Include tests for your changes, otherwise I may accidentally break them in the future.
-
Run the tests with the
rakecommand. Make sure that they are still passing. -
Stage partial-file changesets (
git -p). -
Commit your changes (
git commit). Make exactly as many commits as you need. Each commit should do one thing and one thing only. For example, all whitespace fixes should be relegated to a single commit. -
Write descriptive commit messages, in accordance with these guidelines.
-
Hide the sausage making. Squash, split and reorder commits if necessary (
git rebase -i). For a more in-depth look at interactive rebasing, be sure to check how to rewrite history. -
Push the branch to GitHub (
git push origin my-new-feature). -
Create a new Pull Request and send it to be merged with the master branch.
You are welcome to clarify how something works or simply fix a typo. Please include [ci skip] on a new line in each of your commit messages. This will signal Travis that running the test suite is not necessary for these changes.
If you are experiencing unexpected behavior and, after having read RubyCritic's documentation, are convinced this behavior is a bug, please:
-
Search the issues tracker to see if it was already reported / fixed.
-
Include the Ruby, RubyCritic and Guard:RubyCritic versions in your report. Here's a little table to help you out:
| | Version |
|-------------------|---------|
| Ruby | 2.1.2 |
| RubyCritic | 1.0.0 |
| Guard::RubyCritic | 1.0.0 |
The more information you provide, the easier it will be to track down the issue and fix it.
- Create a new issue.