Commit b00640b
authored
docs(readme): surface the security policy from the README (#577)
## 🗒️ Description / Motivation
Aligns ethlambda with [ethrex's security policy
setup](https://github.com/lambdaclass/ethrex/blob/main/.github/SECURITY.md).
`.github/SECURITY.md` **already exists here and is byte-identical to
ethrex's** (modulo two trailing-whitespace differences, which ours does
not have), so no changes were needed to the policy itself. What was
missing is ethrex's README pointer to it: the policy was only reachable
through GitHub's Security tab, so anyone reading the repo front page had
no idea where to report a vulnerability.
## What Changed
- `README.md`: new `## Security` section, placed just before `##
Contributing` to match ethrex's ordering. Text is copied from ethrex's
README section verbatim, including the repo-relative
`../../security/advisories/new` advisory link (which resolves correctly
under this repo) and the `security@lambdaclass.com` fallback.
## Correctness / Behavior Guarantees
Docs only. No code, config, or build changes.
## Tests Added / Run
None; documentation-only change. Verified the two new links resolve:
- `./.github/SECURITY.md` exists in-tree.
- `../../security/advisories/new` is the same relative form ethrex uses,
resolving to
`https://github.com/lambdaclass/ethlambda/security/advisories/new`.
## Related Issues / PRs
- Related to lambdaclass/ethrex `.github/SECURITY.md`
## ✅ Verification Checklist
- [ ] Ran `make fmt` — clean
- [ ] Ran `make lint` (clippy with `-D warnings`) — clean
- [ ] Ran `make test` (`cargo test --workspace --profile release-fast`)
— all passing
_(Not run: no Rust sources touched.)_1 parent cd6c468 commit b00640b
1 file changed
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
155 | 164 | | |
156 | 165 | | |
157 | 166 | | |
0 commit comments