Skip to content

Commit 698c972

Browse files
authored
docs: improve CONTRIBUTORS guide(s) (#153)
1 parent 8aecbbd commit 698c972

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ that *all* contributors are expected to follow. This code describes the
1818

1919
See [details on our policy on Code of Conduct](https://github.com/NodeSecure/Governance/blob/main/COC_POLICY.md).
2020

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.
28+
29+
[![OpenAlly](https://discordapp.com/api/guilds/640183220452720650/embed.png?style=banner2)](https://discord.gg/4Wn8rjAtB4)
30+
2131
<a id="developers-certificate-of-origin"></a>
2232
## Developer's Certificate of Origin 1.1
2333

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,13 @@ or
6262
```bash
6363
$ git clone https://github.com/NodeSecure/cli.git
6464
$ cd cli
65+
66+
# install NPM dependencies using package-lock.json
6567
$ npm ci
68+
69+
# run esbuild to bundle/compile front-end assets
6670
$ npm run build
71+
6772
$ npm link
6873
```
6974

@@ -183,6 +188,26 @@ See [Scorecard Public Data](https://github.com/ossf/scorecard#public-data):
183188
> 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.
184189
> Currently, this list is derived from projects hosted on GitHub ONLY.
185190
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+
186211
## Contributors ✨
187212

188213
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

0 commit comments

Comments
 (0)