Skip to content

Commit 8135449

Browse files
committed
chore: improves docs grammar
1 parent f5169b5 commit 8135449

File tree

1 file changed

+21
-24
lines changed

1 file changed

+21
-24
lines changed

Diff for: CONTRIBUTING.md

+21-24
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
We encourage any form of contribution, whether that will be issues, comments, or pull requests. If you are willing to submit a PR, there are a few things we would appreciate that you do to keep the codebase clean:
44

5-
* **Write tests.** We try as close to 100% code coverage as possible on this repo so any new code that gets written should have accompanying tests.
5+
* **Write tests (if applicable).** We try as close to 100% code coverage as possible on this repo, so any new code that gets written should have accompanying tests.
66
* **Follow the linter.** We use our [ESLint configuration with Airbnb JavaScript Styleguide](https://github.com/airbnb/javascript), and we run `npm run lint` in our Travis builds.
77
* **Ask questions if you aren't sure.** If you have any questions while implementing a fix or feature, feel free to create an issue and ask us. We're happy to help!
88

99
## <a name="Submit"></a> Submission Guidelines
1010

1111
### <a name="Submit-issue"></a> Submitting an Issue
1212

13-
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
13+
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available.
1414

1515
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
16-
Before you submit your Pull Request (PR) consider the following guidelines:
16+
Before you submit your Pull Request (PR), consider the following guidelines:
1717

1818
1. Search [GitHub](https://github.com/amejiarosario/dsa.js/pulls) for an open or closed PR
1919
that relates to your submission. You don't want to duplicate effort.
20-
1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add.
21-
Discussing the design up front helps to ensure that we're ready to accept your work.
20+
1. Be sure that an issue describes the problem you're fixing or documents the design for the feature you'd like to add.
21+
Discussing the design upfront helps to ensure that we're ready to accept your work.
2222
1. Fork the `amejiarosario/dsa.js` repo.
2323
1. Make your changes in a new git branch:
2424

@@ -29,14 +29,13 @@ Before you submit your Pull Request (PR) consider the following guidelines:
2929
1. Create your patch, **including appropriate test cases**.
3030
1. Run the full test suite, and ensure that all tests pass.
3131
1. Commit your changes using a descriptive commit message that follows our
32-
[commit message conventions](#commit). Adherence to these conventions
33-
is necessary because release notes are automatically generated from these messages.
32+
[commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages.
3433

3534
```shell
3635
git commit -a
3736
```
3837

39-
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
38+
Note: the optional commit `-a` command-line option will automatically "add" and "rm" edited files.
4039

4140
1. Push your branch to GitHub:
4241

@@ -88,8 +87,8 @@ from the main (upstream) repository:
8887
8988
## <a name="commit"></a> Commit Message Guidelines
9089
91-
We have some guidelines how our git commit messages can be formatted. This leads to **more
92-
readable messages** that are easy to follow when looking through the **project history**. But also,
90+
We have some guidelines on how our git commit messages can be formatted. These rules lead to more
91+
readable messages that are easy to follow when looking through the project history. But also,
9392
we use the git commit messages to **generate the change log**.
9493
9594
### Commit Message Format
@@ -104,22 +103,21 @@ format that includes a **type**, a **scope** and a **subject**:
104103
<footer>
105104
```
106105
107-
Example of a commit with header, body and footer:
106+
Example of a commit with header, body, and footer:
108107
109108
```
110109
fix(linked-list): insert in the middle bug
111110
112-
When inserting an item on the middle of a linked list one reference was not being updated properly.
111+
One reference was not updated when inserting an item in the middle of a linked list.
113112
114113
Fixes: #8
115114
```
116115
117-
The **header** is mandatory and the **scope** of the header is optional.
116+
The **header** is mandatory, and the **scope** of the header is optional.
118117
119-
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
120-
to read on GitHub as well as in various git tools.
118+
Any line of the commit message cannot be longer than 100 characters! This length allows the message to be easier to read on GitHub as well as in various git tools.
121119
122-
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
120+
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/), if any.
123121
124122
125123
Examples:
@@ -135,7 +133,7 @@ fix(book/solutions): fix missing solutions
135133
```
136134
137135
### Revert
138-
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
136+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the reverted commit's header. The body should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
139137

140138
### Type
141139
Must be one of the following:
@@ -145,23 +143,22 @@ Must be one of the following:
145143
* **chore**: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
146144

147145
### Scope
148-
The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.
149-
150-
The following is an example of supported scopes:
146+
The scope should be the main directory name. The following is an example of recommended scopes:
151147

152148
* **list**
153149
* **map**
154150
* **tree**
155151
* **graph**
156152
* **sorting**
153+
* **book**
157154
* etc.
158155

159156
### Subject
160157
The subject contains a succinct description of the change:
161158

162-
* use the imperative, present tense: "change" not "changed" nor "changes"
163-
* don't capitalize the first letter
164-
* no dot (.) at the end
159+
* Use the imperative, present tense: "change" not "changed" nor "changes".
160+
* Don't capitalize the first letter.
161+
* Don't dot (.) at the end.
165162

166163
### Body
167164
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
@@ -175,7 +172,7 @@ reference GitHub issues that this commit **Closes**.
175172
Closes #234
176173
```
177174

178-
**Breaking Changes** should start with the word `BREAKING CHANGE:` on the footer with a space or two newlines. The rest of the commit message is then used for this.
175+
**Breaking Changes** should start with the word `BREAKING CHANGE:` on the footer with space or two newlines. The rest of the commit message is then used for this.
179176

180177
Examples of breaking changes include:
181178

0 commit comments

Comments
 (0)