|
3 | 3 | ## Rules
|
4 | 4 |
|
5 | 5 | 1. **Test everything you add or fix**. Functionality that is not tested is a headache to the future.
|
6 |
| -1. **Document everything you add**, even an small option. If the functionality is hidden in the code, it is not useful. |
| 6 | +1. **Document everything you add**, even a small option. If the functionality is hidden in the code, it is not useful. |
7 | 7 | In general, we add a brief in the `README.md` and we extend the information in a file inside `/docs`.
|
8 | 8 | 1. **Avoid making Pull Requests with multiple changes**. If you intend to add/fix several things, please make a PR for each one.
|
9 | 9 | 1. **Ask before attempting to add new features**. In Platanus, we open the code of this gem to spread the happiness but we don't want to maintain things that are not useful for the company. Remember that you can always fork this gem and modify it according to your needs.
|
10 |
| -1. **Respect the style rules**. We use [rubocop](https://github.com/bbatsov/rubocop), [stylelint](https://github.com/stylelint/stylelint) and [eslint](https://eslint.org/). Te rules are in the root of this gem. |
| 10 | +1. **Respect the style rules**. We use [rubocop](https://github.com/bbatsov/rubocop) and [eslint](https://eslint.org/). The rules are in the root of this gem. Any changes added to the PR because of a style rule violation should be added to the original commit in your branch with a [`git rebase`](https://help.github.com/articles/about-git-rebase/), don't add "style fix" as separate commits. |
| 11 | +1. **Use the template when submitting a PR** |
11 | 12 |
|
12 | 13 | ## Dummy App
|
13 | 14 |
|
@@ -44,17 +45,8 @@ If you're using homebrew on OS X you can do: `brew install chromedriver`.
|
44 | 45 | To run the tests you can do, in the root of the gem:
|
45 | 46 |
|
46 | 47 | ```
|
47 |
| -# For running helper specs (/lib directory) |
48 | 48 | bundle exec rake tests
|
49 |
| -
|
50 |
| -# For running with all tests |
51 |
| -bundle exec rake tests |
52 |
| -
|
53 | 49 | ```
|
54 | 50 |
|
55 |
| -- The addons specs we put them inside `/spec/features`. |
56 |
| -- The helper classes specs we put them inside `/spec/lib`. |
57 |
| - |
58 |
| -## Style rules |
59 |
| - |
60 |
| -We use [Hound](https://houndci.com/) to check the style rules against pull requests. So, you don't need to install the code analyzers or linters if you don't want. But, don't make commits named "style fix" when the hound attacks you, or do it but use [`git rebase`](https://help.github.com/articles/about-git-rebase/). |
| 51 | +- We put the addons specs inside `/spec/features`. |
| 52 | +- We put the helper classes specs inside `/spec/lib`. |
0 commit comments