Add contracts acceptance criteria self-review template

[El-swaggerito]

Description

Difficulty: Hard

Type: Documentation

Summary

Create a self-review template for contract contributors before review.

Current Behaviour

Contributors may not check whether all contract issue requirements are satisfied.

Expected Behaviour

The contracts repo should provide a template covering behaviour, tests, CI, security, edge cases, and docs.

Suggested Implementation

Create self-review docs and PR template references.

Files or Areas Likely Affected

• docs/
• .github/
• README.md

Acceptance Criteria

• Self-review template is added.
• Behaviour requirements are covered.
• Security and edge cases are covered.
• Tests and CI are covered.
• Docs impact is included.
• README links to the template.

Additional Notes

This supports objective pre-payment self-evaluation.

[vickman787]

Hi, I'd like to take this on.

Since this template needs to cover behaviour, tests, CI, security, edge cases, and docs, I want the template itself to reflect real characteristics of a contracts repo (gas/compute concerns, reentrancy-style risks, upgrade paths) rather than being a generic checklist that could apply to any PR in any language. I'll confirm the actual contract stack and existing conventions (test framework, CI config, any existing PR template) before writing anything, so the template speaks the repo's actual language.

My plan:

Check what already exists first — whether there's a .github/PULL_REQUEST_TEMPLATE.md already, and whether docs/ has any existing contribution guidelines this should sit alongside rather than duplicate.
Structure the template around the six required areas, each with concrete yes/no or short-answer prompts, not vague prose questions:
Behaviour: does the change satisfy every acceptance criterion in the linked issue, verbatim, one line per criterion?
Tests: new/changed logic covered, both success and failure paths; any state transition has a test asserting the before/after state, not just "it doesn't revert."
CI: full suite passes locally, not just the changed test file, and any new dependency doesn't break the build.
Security: reentrancy, overflow/underflow, access control on any new external/public function, and whether the change touches funds-moving logic (which should get extra scrutiny called out explicitly in the template, not buried alongside cosmetic checks).
Edge cases: zero-value inputs, max-value inputs, already-finalized/already-claimed state, and any assumption about caller identity.
Docs: whether the change affects any user-facing interface (function signature, event, error type) that needs a corresponding doc update.
Add it as docs/self-review-template.md, with a short reference to it added to the actual PR template (if one exists) so contributors see it at the point of opening a PR, not just if they happen to browse docs/.
Link it from README.md, in whatever contribution/development section already exists.
Go through the acceptance criteria literally once done — six items, each independently checkable against the doc — since that mirrors exactly what I'd be asking contributors to do with the template itself.

Given the "Hard" label, I'd guess the real difficulty is producing security/edge-case prompts specific enough to this contract codebase to be useful rather than boilerplate ("check for reentrancy" is table stakes; the useful version references this repo's actual patterns, like whether it uses a specific reentrancy guard or upgrade proxy pattern already). I'll spend the bulk of my time there rather than on the docs/README wiring, which is comparatively mechanical.

[grantfox-oss]

🦊 GrantFox — @vickman787 has been assigned to this issue as part of the Official Campaign | FWC26 campaign!

Next steps:

1. Open a Pull Request referencing this issue (e.g., Closes #513)
2. Your PR will be reviewed by the Axionvera maintainers

Good luck! Track your progress on GrantFox.

[grantfox-oss]

🎉 This issue has been marked as completed on GrantFox as part of the Official Campaign | FWC26 campaign!

@vickman787's PR #548 was approved and merged by @El-swaggerito.

🏆 @vickman787: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (253 total points). Track your full progress on GrantFox.

👏 Great work, @vickman787! Keep contributing to Axionvera.