Skip to content

Commit e25132b

Browse files
authored
docs(contributing): spelling and grammar fixes (#879)
1 parent e53b441 commit e25132b

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Testing changes locally
44

55
You might try a TDD approach and add tests within the `test` directory,
6-
to try different configs, you may find it easier to try out changes in
6+
to try different configs you may find it easier to try out changes in
77
a separate local directory.
88

99
You can run [`npm link`](https://docs.npmjs.com/cli/link) for this purpose,
@@ -18,7 +18,7 @@ npm link ../eslint-plugin-jsdoc
1818

1919
After running `npm install` to get the latest dependencies and devDependencies,
2020
you can run the following command to update the `dist` files, with `dist/index.js`
21-
being the `main` entrance point from `package.json`:
21+
being the `main` entry point from `package.json`:
2222

2323
```shell
2424
npm run build
@@ -33,22 +33,22 @@ items needing fixing.
3333

3434
## Documentation building
3535

36-
In order to make changes that are reflected in the README, you will need to
36+
To make changes that are reflected in the README, you will need to
3737
modify files within the `.README` directory. `.README/README.md` contains the
3838
main README skeleton and details on the project, its global `settings`, etc.,
39-
while the documentation for specific rules (that will get pulled into the
39+
while the documentation for specific rules (that will be pulled into the
4040
README) ought to be modified within the relevant file within `.README/rules`.
4141
Once these files are modified, you can run `npm run create-readme` to have
4242
these files integrated into the main `/README.md`. While you should include
43-
the built file in your PR, you will do not want to make manual changes
44-
directly to this file as they will be overwritten.
43+
the built file in your PR, you will not want to make manual changes
44+
directly to this file, as they will be overwritten.
4545

4646
## Testing
4747

4848
Tests are expected. Each rule file should be in CamelCase (despite the rule names themselves being hyphenated) and should be added within `test/assertions` and then imported/required by
4949
`test/rules/index.js`.
5050

51-
Each rule file should be an ESM default export of an object which has `valid` and `invalid` array properties containing the tests. Tests of each type should be provided.
51+
Each rule file should be an ESM default export of an object that has `valid` and `invalid` array properties containing the tests. Tests of each type should be provided.
5252

5353
`parserOptions` will be `ecmaVersion: 6` by default, but tests can override `parserOptions`
5454
with their own.
@@ -57,8 +57,8 @@ See ESLint's [RuleTester](https://eslint.org/docs/developer-guide/nodejs-api#rul
5757
for more on the allowable properties (e.g., `code`, `errors` (for invalid rules),
5858
`options`, `settings`, etc.).
5959

60-
Note that besides `npm test`, there is `npm run test-cov` which shows more
61-
detailed information on coverage. Coverage should be maintained at 100%, and
60+
Note that besides `npm test` there is `npm run test-cov`, which shows more
61+
detailed coverage information. Coverage should be maintained at 100%, and
6262
if there are a few guards in place for future use, the code block in question
6363
can be ignored by being preceded by `/* istanbul ignore next */` (including
6464
for warnings where the block is never passed over (i.e., the block is always
@@ -75,7 +75,7 @@ You can further limit this by providing `--invalid` and/or `--valid` flags
7575
with a comma-separated list of 0-based indexes that you wish to include (also
7676
accepts negative offsets from the end, e.g., `-1` for the last item). For
7777
example, to check the first and third invalid tests of `check-examples`
78-
alon with the second valid test, you can run:
78+
along with the second valid test, you can run:
7979

8080
`npm run --rule=check-examples --invalid=0,2 --valid=1 test-index`.
8181

@@ -84,7 +84,7 @@ alon with the second valid test, you can run:
8484
PRs should be mergeable, [rebasing](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
8585
first against the latest `master`.
8686

87-
The number of commits will ideally be limited in number, unless extra commits
87+
The number of commits will ideally be limited unless extra commits
8888
can better show a progression of features.
8989

9090
Commit messages should be worded clearly and the reason for any PR made clear
@@ -96,5 +96,5 @@ We use [semantic-release](https://github.com/semantic-release/semantic-release)
9696
for preparing releases, so the commit messages (or at least the merge that
9797
brings them into `master`) must follow the
9898
[AngularJS commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) with a special format such as `feat: describe new feature`
99-
in order for the releasing to occur and for the described items to be added
99+
for releases to occur and for the described items to be added
100100
to the release notes.

0 commit comments

Comments
 (0)