Skip to content

Commit fb27e72

Browse files
doc: Update CONTRIBUTING.md
* Update CONTRIBUTING.md Corrections of misspelled words. PR-URL: #1185 Reviewed-By: Michael Dawson <[email protected]>
1 parent e9def3e commit fb27e72

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
By making a contribution to this project, I certify that:
55

66
(a) The contribution was created in whole or in part by me and I
7-
have the right to submit it under the open source license
7+
have the right to submit it under the open-source license
88
indicated in the file; or
99

1010
(b) The contribution is based upon previous work that, to the best
1111
of my knowledge, is covered under an appropriate open source
1212
license and I have the right under that license to submit that
1313
work with modifications, whether created in whole or in part
14-
by me, under the same open source license (unless I am
14+
by me, under the same open-source license (unless I am
1515
permitted to submit under a different license), as indicated
1616
in the file; or
1717

1818
(c) The contribution was provided directly to me by some other
19-
person who certified (a), (b) or (c) and I have not modified
19+
person who certified (a), (b), or (c) and I have not modified
2020
it.
2121

2222
(d) I understand and agree that this project and the contribution
@@ -38,21 +38,21 @@ contribute to **node-addon-api**:
3838

3939
**node-addon-api** is meant to be a thin convenience wrapper around Node-API. With this
4040
in mind, contributions of any new APIs that wrap around a core Node-API API will
41-
be considered for merge. However, changes that wrap existing **node-addon-api**
41+
be considered for merging. However, changes that wrap existing **node-addon-api**
4242
APIs are encouraged to instead be provided as an ecosystem module. The
4343
**node-addon-api** team is happy to link to a curated set of modules that build on
4444
top of **node-addon-api** if they have broad usefulness to the community and promote
4545
a recommended idiom or pattern.
4646

4747
### Rationale
4848

49-
The Node-API team considered a couple different approaches with regards to changes
49+
The Node-API team considered a couple of different approaches with regard to changes
5050
extending **node-addon-api**
5151
- Larger core module - Incorporate these helpers and patterns into **node-addon-api**
5252
- Extras package - Create a new package (strawman name '**node-addon-api**-extras')
5353
that contain utility classes and methods that help promote good patterns and
5454
idioms while writing native addons with **node-addon-api**.
55-
- Ecosystem - Encourage creation of a module ecosystem around **node-addon-api**
55+
- Ecosystem - Encourage the creation of a module ecosystem around **node-addon-api**
5656
where folks can build on top of it.
5757

5858
#### Larger Core
@@ -65,9 +65,9 @@ The downside of the approach is the following:
6565
- More maintenance burden on the Node-API WG core team.
6666

6767
#### Extras Package
68-
This involves us spinning up a new package which contains the utility classes
68+
This involves us spinning up a new package that contains the utility classes
6969
and methods. This has the benefit of having a separate module where helpers
70-
which make it easier to implement certain patterns and idioms for native addons
70+
make it easier to implement certain patterns and idioms for native addons
7171
easier.
7272

7373
The downside of this approach is the following:
@@ -86,8 +86,8 @@ modules (listing them out on the repository/wiki, using them in workshops/tutori
8686
etc).
8787

8888
The downside of this approach is the following:
89-
- Potential for lack of visibility - evangelism and education is hard, and module
90-
authors might not find right patterns and instead implement things themselves
89+
- Potential for lack of visibility. Evangelism and education are hard, and module
90+
authors might not find the right patterns and instead implement things themselves
9191
- There might be greater friction for the Node-API WG in evolving APIs since the
9292
ecosystem would have taken dependencies on the API shape of **node-addon-api**
9393

0 commit comments

Comments
 (0)