Skip to content

Commit e823150

Browse files
committed
Updates to rubocop instructions
1 parent 161492b commit e823150

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

common_plaintext_files/BUILD_DETAIL.md.erb

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,11 @@ $ bundle exec yard doc --no-cache
9292
$ bin/yard doc --no-cache
9393
```
9494

95-
## Rubocop
95+
## RuboCop
9696

97-
We use [Rubocop](https://github.com/bbatsov/rubocop) to enforce style conventions on the project so
98-
that the code has stylistic consistency throughout. Run with:
97+
We use [RuboCop](https://github.com/rubocop-hq/rubocop) to enforce style
98+
conventions on the project so that the code has stylistic consistency
99+
throughout. Run with:
99100

100101
```
101102
$ bundle exec rubocop lib
@@ -105,9 +106,9 @@ $ bundle exec rubocop lib
105106
$ bin/rubocop lib
106107
```
107108

108-
Our Rubocop configuration is a work-in-progress, so if you get a failure
109-
due to a Rubocop default, feel free to ask about changing the
110-
configuration. Otherwise, you'll need to address the Rubocop failure,
109+
Our RuboCop configuration is a work-in-progress, so if you get a failure
110+
due to a RuboCop default, feel free to ask about changing the
111+
configuration. Otherwise, you'll need to address the RuboCop failure,
111112
or, as a measure of last resort, by wrapping the offending code in
112113
comments like `# rubocop:disable SomeCheck` and `# rubocop:enable SomeCheck`.
113114

@@ -141,4 +142,3 @@ build for another repo, so our CI build includes a spec that runs the
141142
spec suite of each of the _other_ project repos. Note that we only run
142143
the spec suite, not the full build, of the other projects, as the spec
143144
suite runs very quickly compared to the full build.
144-

common_plaintext_files/DEVELOPMENT.md.erb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Here's a short, non-exhaustive checklist of things we typically ask contributors
103103
- [ ] New behavior is covered by tests and all tests are passing.
104104
- [ ] No Ruby warnings are issued by your changes.
105105
- [ ] Documentation reflects changes and renders as intended.
106-
- [ ] Rubocop passes (e.g. `bundle exec rubocop lib`).
106+
- [ ] RuboCop passes (e.g. `bundle exec rubocop lib`).
107107
- [ ] Commits are squashed into a reasonable number of logical changesets that tell an easy-to-follow story.
108108
- [ ] No changelog entry is necessary (we'll add it as part of the merge process!)
109109

@@ -124,4 +124,3 @@ $ bin/yard server --reload
124124
```
125125

126126
Then navigate to `localhost:8808` to view the rendered docs.
127-

0 commit comments

Comments
 (0)