Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve CONTRIBUTORS guide(s) #153

Merged
merged 1 commit into from
Jan 22, 2023
Merged

docs: improve CONTRIBUTORS guide(s) #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ that *all* contributors are expected to follow. This code describes the

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

## First-contributor guide

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.

## Discord

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.

[![OpenAlly](https://discordapp.com/api/guilds/640183220452720650/embed.png?style=banner2)](https://discord.gg/4Wn8rjAtB4)

<a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1

Expand Down
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,13 @@ or
```bash
$ git clone https://github.com/NodeSecure/cli.git
$ cd cli

# install NPM dependencies using package-lock.json
$ npm ci

# run esbuild to bundle/compile front-end assets
$ npm run build

$ npm link
```

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

## Contributors guide

If you are a developer **wishing to contribute** to the project, you must first read the [CONTRIBUTING](./CONTRIBUTING.md) guide.

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:

```bash
$ npm run build
```

> **Warning** restart this command when modifying files in the public root folder

Once you have finished your development, check that the tests (and linter) are still good by running the following script:

```bash
$ npm test
```

> **Note** If you add a feature, try adding tests for it along.

## Contributors ✨

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