Merge pull request #458 from platanus/contributing-changes

Contributing changes

Author: difernandez

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Report a bug that could be fixed
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+Include either code to reproduce, or a link to a repo with the problem.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FR]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+### Motivation / Background
+
+<!--
+Describe why this Pull Request needs to be merged. What bug have you fixed? What feature have you added? Why is it important?
+If you are addressing a specific issue (a bug or a feature request), include "Closes #ISSUE" (replace with the issue number, remove the quotes) and the issue will be linked to this PR.
+-->
+
+This Pull Request has been created because [REPLACE ME]
+
+### Detail
+
+This Pull Request changes [REPLACE ME]
+
+### Additional information
+
+<!-- Provide additional information such as benchmarks, reference to other repositories, screenshots or alternative solutions. -->
+
+### Checklist
+
+Before submitting the PR make sure the following are checked:
+
+* [ ] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
+* [ ] Commit message has a concise description of what changed and why.
+* [ ] Tests are added or updated if you fix a bug or add a feature.
+* [ ] Documentation has been added or updated if you add a feature or modify an existing one.
+* [ ] CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature (under the "Unreleased" heading if this is not a version change).
+* [ ] My changes don't introduce any linter rule violations.

README.md

@@ -250,10 +250,9 @@ On master/main branch...
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. If you changed the javascript/scss files, run `yarn build`.
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 If you want to collaborate, please check [the rules](docs/CONTRIBUTING.md) first.
 

docs/CONTRIBUTING.md

@@ -3,11 +3,12 @@
 ## Rules
 
 1. **Test everything you add or fix**. Functionality that is not tested is a headache to the future.
-1. **Document everything you add**, even an small option. If the functionality is hidden in the code, it is not useful.
+1. **Document everything you add**, even a small option. If the functionality is hidden in the code, it is not useful.
 In general, we add a brief in the `README.md` and we extend the information in a file inside `/docs`.
 1. **Avoid making Pull Requests with multiple changes**. If you intend to add/fix several things, please make a PR for each one.
 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.
-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.
+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.
+1. **Use the template when submitting a PR** 
 
 ## Dummy App
 
@@ -44,17 +45,8 @@ If you're using homebrew on OS X you can do: `brew install chromedriver`.
 To run the tests you can do, in the root of the gem:
 
 ```
-# For running helper specs (/lib directory)
 bundle exec rake tests
-
-# For running with all tests
-bundle exec rake tests
-
 ```
 
-- The addons specs we put them inside `/spec/features`.
-- The helper classes specs we put them inside `/spec/lib`.
-
-## Style rules
-
-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/).
+- We put the addons specs inside `/spec/features`.
+- We put the helper classes specs inside `/spec/lib`.