Skip to content

Commit b907679

Browse files
committed
docs(contributing): update contributing docs
1 parent 429bd19 commit b907679

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,9 @@ On master/main branch...
250250

251251
1. Fork it
252252
2. Create your feature branch (`git checkout -b my-new-feature`)
253-
3. If you changed the javascript/scss files, run `yarn build`.
254-
4. Commit your changes (`git commit -am 'Add some feature'`)
255-
5. Push to the branch (`git push origin my-new-feature`)
256-
6. Create new Pull Request
253+
3. Commit your changes (`git commit -am 'Add some feature'`)
254+
4. Push to the branch (`git push origin my-new-feature`)
255+
5. Create new Pull Request
257256

258257
If you want to collaborate, please check [the rules](docs/CONTRIBUTING.md) first.
259258

docs/CONTRIBUTING.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
## Rules
44

55
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.
77
In general, we add a brief in the `README.md` and we extend the information in a file inside `/docs`.
88
1. **Avoid making Pull Requests with multiple changes**. If you intend to add/fix several things, please make a PR for each one.
99
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**
1112

1213
## Dummy App
1314

@@ -44,17 +45,8 @@ If you're using homebrew on OS X you can do: `brew install chromedriver`.
4445
To run the tests you can do, in the root of the gem:
4546

4647
```
47-
# For running helper specs (/lib directory)
4848
bundle exec rake tests
49-
50-
# For running with all tests
51-
bundle exec rake tests
52-
5349
```
5450

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

Comments
 (0)