Skip to content

Commit b1ecd57

Browse files
authored
docs: readme updated with security section (#39)
1 parent 3659429 commit b1ecd57

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

.changeset/witty-stamps-draw.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@fetchkit/ffetch': patch
3+
---
4+
5+
docs: readme updated with security section

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ ffetch uses a plugin architecture for optional features, so you only include wha
4949
- [Fetch vs. Axios vs. ky vs. `ffetch`](#fetch-vs-axios-vs-ky-vs-ffetch)
5050
- [Try ffetch in Action](#try-ffetch-in-action)
5151
- [Join the Community](#join-the-community)
52+
- [Security](#security)
5253
- [Contributing](#contributing)
5354
- [License](#license)
5455

@@ -386,6 +387,23 @@ Got questions, want to discuss features, or share examples? Join the **Fetch-Kit
386387

387388
[![Discord](https://img.shields.io/badge/Discord-Join_Fetch--Kit-7289DA?logo=discord&logoColor=white)](https://discord.gg/sdyPBPCDUg)
388389

390+
## Security
391+
392+
`ffetch` is scored at **7.4/10** by the [OpenSSF Scorecard](https://securityscorecards.dev/), an automated security health check for open source projects.
393+
394+
The score reflects:
395+
- ✅ Pinned GitHub Actions dependencies
396+
- ✅ CodeQL static analysis on every PR and push to main
397+
- ✅ Dependabot for dependency updates and security alerts
398+
- ✅ npm publish with OIDC provenance attestations
399+
- ✅ Security policy and private vulnerability reporting
400+
- ✅ Branch protection on `main`
401+
- ✅ SPDX SBOM attached to every release
402+
403+
The score is capped below 10 due to being a solo-maintained project (no mandatory code review or multiple org contributors). [View the full breakdown](https://scorecard.dev/viewer/?uri=github.com/fetch-kit/ffetch).
404+
405+
To report a security vulnerability, see [SECURITY.md](./SECURITY.md).
406+
389407
## Contributing
390408

391409
- **Issues**: [GitHub Issues](https://github.com/fetch-kit/ffetch/issues)

0 commit comments

Comments
 (0)