4
4
By making a contribution to this project, I certify that:
5
5
6
6
(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
8
8
indicated in the file; or
9
9
10
10
(b) The contribution is based upon previous work that, to the best
11
11
of my knowledge, is covered under an appropriate open source
12
12
license and I have the right under that license to submit that
13
13
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
15
15
permitted to submit under a different license), as indicated
16
16
in the file; or
17
17
18
18
(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
20
20
it.
21
21
22
22
(d) I understand and agree that this project and the contribution
@@ -38,21 +38,21 @@ contribute to **node-addon-api**:
38
38
39
39
** node-addon-api** is meant to be a thin convenience wrapper around Node-API. With this
40
40
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**
42
42
APIs are encouraged to instead be provided as an ecosystem module. The
43
43
** node-addon-api** team is happy to link to a curated set of modules that build on
44
44
top of ** node-addon-api** if they have broad usefulness to the community and promote
45
45
a recommended idiom or pattern.
46
46
47
47
### Rationale
48
48
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
50
50
extending ** node-addon-api**
51
51
- Larger core module - Incorporate these helpers and patterns into ** node-addon-api**
52
52
- Extras package - Create a new package (strawman name '** node-addon-api** -extras')
53
53
that contain utility classes and methods that help promote good patterns and
54
54
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**
56
56
where folks can build on top of it.
57
57
58
58
#### Larger Core
@@ -65,9 +65,9 @@ The downside of the approach is the following:
65
65
- More maintenance burden on the Node-API WG core team.
66
66
67
67
#### 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
69
69
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
71
71
easier.
72
72
73
73
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
86
86
etc).
87
87
88
88
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
91
91
- There might be greater friction for the Node-API WG in evolving APIs since the
92
92
ecosystem would have taken dependencies on the API shape of ** node-addon-api**
93
93
0 commit comments