Skip to content

Commit

Permalink
Update CONTRIBUTING.md to include Simplecov
Browse files Browse the repository at this point in the history
  • Loading branch information
corsonknowles committed Feb 9, 2025
1 parent 27e37d5 commit 8429c46
Showing 1 changed file with 38 additions and 7 deletions.
45 changes: 38 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ If you encounter problems or have ideas for improvements or new features, please
## Pull requests

1. Fork the project.
2. Create a feature branch.
3. Make sure to add tests.
4. Make sure the test suite passes (run `rake`).
5. Add a [changelog](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md) entry.
6. Commit your changes.
7. Push to the branch.
8. Create new Pull Request.
1. Create a feature branch.
1. Make sure to add tests.
1. Make sure the test suite passes (run `rake`).
1. Add a [changelog](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md) entry.
1. Commit your changes.
1. Push to the branch.
1. Create new Pull Request.

### Spell Checking

Expand Down Expand Up @@ -51,6 +51,37 @@ We are running [mdformat](https://github.com/executablebooks/mdformat) for forma
$ mdformat . --number
```

### Test Coverage - Line and Branch

We are using [Simplecov](https://github.com/colszowka/simplecov) to track test coverage.

It is included and reported when you run `bundle exec rake` or `bundle exec rspec`.

To view the coverage report, open the `coverage/index.html` file in your browser.

E.g. on macOS:

```console
$ open coverage/index.html
```

If you have unreachable lines, you can add `# :nocov` around those lines. The code itself or a comment should explain why the line is unreachable.

Example:

```ruby
# :nocov:
raise ArgumentError("Unsupported style :#{style}")
# :nocov:
```

This can happen for a few reasons, including:

1. When you handle config with a case statement and there is no else block.
1. When matching with a node pattern even when you handle all cases: all other node types will be excluded before reaching your handler, because the node pattern will not match them.

You will need full line and branch coverage to merge. This helps detect edge cases and prevent errors.

## Creating new cops

- Document examples of good and bad code in your cop.
Expand Down

0 comments on commit 8429c46

Please sign in to comment.