Skip to content

Add contributor security checklist for contract changes #418

Description

@El-swaggerito

Description

Difficulty: Expert

Type: Documentation

Summary

Create a contributor security checklist for all vault contract changes.

Current Behaviour

Contributors may modify sensitive contract logic without checking accounting, authorisation, storage, events, and failure behaviour.

Expected Behaviour

The repository should provide a practical checklist that maintainers can use during PR review.

Suggested Implementation

Add checklist items covering balance invariants, lock state, token transfer atomicity, authorisation, storage migration, event compatibility, error codes, and test requirements.

Files or Areas Likely Affected

  • docs/
  • README.md
  • src/
  • tests/

Acceptance Criteria

  • Security checklist is added.
  • Accounting and lock checks are included.
  • Token transfer safety is included.
  • Authorisation checks are included.
  • Storage and event checks are included.
  • README links to the checklist.

Additional Notes

This improves review quality.

Metadata

Metadata

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelcontractSmart contract related workdeveloper-experienceDeveloper experience workdocumentationDocumentation workexpertExpert difficultysecuritySecurity sensitive work

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions