Skip to content

Commit

Permalink
Add run rubocop to contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bellvat committed Jan 8, 2018
1 parent 6d302db commit 4b0503d
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
Expand Up @@ -2,7 +2,7 @@

1. [Fork the repo](https://help.github.com/articles/fork-a-repo/).
2. Clone your repo.

```
git clone git@github.com:USERNAME/planner.git
cd planner
Expand All @@ -16,23 +16,27 @@
rails server
```

4. Have a look around to get a feel for the app.
5. Run the tests. We only take pull requests with passing tests, and it's great to confirm that you have a clean slate.
4. Have a look around to get a feel for the app.
5. Run the tests. We only take pull requests with passing tests, and it's great to confirm that you have a clean slate.

```
rake
```

6. Add a test for your change - unless you are refactoring or adjusting styles and documentation. If you are adding any functionality or fixing a bug, we need a test!
7. Implement your change and ensure all the tests pass.
8. Commit, with a meaningful & descriptive message - this is very important!
8. Run Rubocop to ensure you are complying with the Ruby style guide. Refer to (https://rubocop.readthedocs.io/en/latest/) for cops/violation details.
```
rubocop
```
9. Commit, with a meaningful & descriptive message - this is very important!

```
git commit -m "Title for your commit" -m "A little more explanation"
```

9. Push to your fork and [open a pull request on Github](https://help.github.com/articles/creating-a-pull-request/) to the upstream repository.
10. Wait for comments and feedback - we usually get back super fast!
10. Push to your fork and [open a pull request on Github](https://help.github.com/articles/creating-a-pull-request/) to the upstream repository.
11. Wait for comments and feedback - we usually get back super fast!

Syntax guidelines:

Expand Down

0 comments on commit 4b0503d

Please sign in to comment.