You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+10
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,16 @@ that *all* contributors are expected to follow. This code describes the
18
18
19
19
See [details on our policy on Code of Conduct](https://github.com/NodeSecure/Governance/blob/main/COC_POLICY.md).
20
20
21
+
## First-contributor guide
22
+
23
+
If this is your first open source contribution, we [have a special guide](https://github.com/NodeSecure/Governance/blob/main/guides/contributor-en.md) to help you.
24
+
25
+
## Discord
26
+
27
+
Our project has a discord that allows mutual cooperation between (new-)contributors. We are very welcoming and respectful, do not hesitate to come and ask us questions if you are in trouble.
# install NPM dependencies using package-lock.json
65
67
$ npm ci
68
+
69
+
# run esbuild to bundle/compile front-end assets
66
70
$ npm run build
71
+
67
72
$ npm link
68
73
```
69
74
@@ -183,6 +188,26 @@ See [Scorecard Public Data](https://github.com/ossf/scorecard#public-data):
183
188
> We run a weekly Scorecard scan of the 1 million most critical open source projects judged by their direct dependencies and publish the results in a BigQuery public dataset.
184
189
> Currently, this list is derived from projects hosted on GitHub ONLY.
185
190
191
+
## Contributors guide
192
+
193
+
If you are a developer **wishing to contribute** to the project, you must first read the [CONTRIBUTING](./CONTRIBUTING.md) guide.
194
+
195
+
If you have already cloned and installed the project with npm locally, you still need to build and bundle front-end assets using the npm `build` script:
196
+
197
+
```bash
198
+
$ npm run build
199
+
```
200
+
201
+
> **Warning** restart this command when modifying files in the public root folder
202
+
203
+
Once you have finished your development, check that the tests (and linter) are still good by running the following script:
204
+
205
+
```bash
206
+
$ npm test
207
+
```
208
+
209
+
> **Note** If you add a feature, try adding tests for it along.
210
+
186
211
## Contributors ✨
187
212
188
213
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
0 commit comments