Skip to content

Commit f7fe94c

Browse files
committed
Add CONTRIBUTING.md
1 parent 2e68d01 commit f7fe94c

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Thanks for considering a contribution to Retire.js.
4+
5+
## Pull requests
6+
7+
- Keep PRs focused on a single change (one bug fix, one library addition, one feature). Unrelated changes make review harder and should go in separate PRs.
8+
- All commits must be signed.
9+
- Describe *why* the change is needed, not just what changed.
10+
11+
## Node CLI (`node/`)
12+
13+
See [node/README.md](node/README.md) for usage and options.
14+
15+
- Build and run the test suite before submitting: `npm run build && npm run test` (specs import from `lib/`, not `src/`, so the build step is required).
16+
- Run `npm run check` (lint + typecheck).
17+
- Tests should be split into one test file per module being tested — e.g. don't bundle tests for `x.ts` and `y.ts` into a shared spec file unless there's no reasonable way to separate them.
18+
19+
## Vulnerability repository (`repository/`)
20+
21+
See [repository/README.md](repository/README.md) for the entry format.
22+
23+
- Make changes in `jsrepository-master.json` only. Never edit `jsrepository.json` directly (it's generated) or submit to `npmrepository.json` (deprecated).
24+
- After editing `jsrepository-master.json`, regenerate derived files with `node convertToVersioned`.
25+
- Before submitting, run `node validate` and `node test-detection.js`.
26+
- Each vulnerability entry needs a `severity`, `cwe`, and at least one identifier (`CVE`, `githubID`, `pr`, or `issue`).
27+
28+
## Browser extensions (`chrome/`, `firefox/`)
29+
30+
See [chrome/README.md](chrome/README.md) and [firefox/README.md](firefox/README.md) for extension-specific details. Note the Firefox extension is deprecated.

0 commit comments

Comments
 (0)