From af1d0bd7b603c3759a3957a76242cb4ca1720f0b Mon Sep 17 00:00:00 2001 From: Esther Ikechukwu Date: Wed, 29 Jul 2026 15:46:29 +0100 Subject: [PATCH] docs: add contributor security checklist for vault contract changes --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 86e2e0b..8b50688 100644 --- a/README.md +++ b/README.md @@ -213,6 +213,7 @@ stellar-pocketpay-contracts/ - [Admin Role](docs/admin-role.md) – Details on the admin address, current capabilities, and future design considerations. - [Admin & Emergency Mechanism Threat Model](docs/admin-pause-threat-model.md) – Security analysis of malicious admin, compromised admin, accidental pause, and blocked-withdrawal scenarios. - [Failure Mode Catalogue](docs/failure-mode-catalogue.md) – Summary of safe-failure behavior, expected errors, affected functions, and related tests for vault operations. +- [Contributor Security Checklist](docs/security-checklist.md) – Practical review checklist for vault contract changes covering accounting, lock state, token transfer safety, authorisation, storage, events, error handling, and tests. - [Contributor Self-Review Template](docs/self-review-template.md) – Copy-paste checklist covering behaviour, tests, CI, security, edge cases, and docs impact — fill it in before opening a PR. - [Traceability Table Guide](docs/traceability-table.md) – Standard format for mapping PR changes to issue acceptance criteria, with worked examples. - [Payment-Period Conduct Guidance](docs/payment-period-conduct.md) – Expectations for how contributors raise payment-status questions, and how GrantFox's evaluation process relates to this repository's review process.