Skip to content

Commit c5c6d53

Browse files
authored
docs: add case study acceptance criteria to CONTRIBUTING.md (#679)
Closes #678
1 parent b7cf428 commit c5c6d53

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ All contributions to this project are voluntary and unpaid. By opening a pull re
2828
- If changes are requested, address the feedback and push to the same branch.
2929
- If your branch falls behind main, rebase it: `git fetch origin && git rebase origin/main && git push --force-with-lease`.
3030

31+
## Case studies
32+
33+
Case studies document real-world scans of popular open-source projects. The portfolio covers all major lockfile types (npm, pnpm, Yarn Berry, Bun) and a range of project sizes and sectors.
34+
35+
A new case study proposal is only accepted if it meets at least one of the following:
36+
37+
1. **New lockfile type** - uses a lockfile type not yet covered in the existing portfolio
38+
2. **New sector** - covers a sector genuinely not yet represented, such as government, healthcare, finance, or hardware (a different kind of developer tool or AI framework does not qualify)
39+
3. **Exceptional gap vs native audit** - the scan reveals a meaningful difference compared to the equivalent package manager audit tool (e.g. the native tool returns zero findings and CVE Lite finds something real, or the deduplication difference is dramatic), documented side-by-side in the study
40+
41+
Before opening a case study issue, scan the project locally with `cve-lite . --verbose` and confirm it meets at least one criterion above. Case study PRs must not edit shared files (`website/docs/case-studies/index.md`, `website/sidebars.ts`, `README.md`, `examples/readme.md`, `CHANGELOG.md`) - those are updated by maintainers post-merge.
42+
3143
## Reporting bugs
3244

3345
Use the [bug report template](https://github.com/OWASP/cve-lite-cli/issues/new?template=bug_report.md). Include your Node.js version, package manager, and the full error output.

0 commit comments

Comments
 (0)