Skip to content

docs: add test-first contribution guide - #138

Merged
El-swaggerito merged 1 commit into
Raegis-RWA:mainfrom
Carlys17:docs/test-first-guide-114
Jul 29, 2026
Merged

docs: add test-first contribution guide#138
El-swaggerito merged 1 commit into
Raegis-RWA:mainfrom
Carlys17:docs/test-first-guide-114

Conversation

@Carlys17

Copy link
Copy Markdown
Contributor

Closes #114

Description

Add a new documentation file docs/test-first-contribution-guide.md that defines the test-first contribution methodology for the Aegis SDK.

The guide covers:

  • When tests are required (table of change types)
  • Module-specific test expectations for all six areas: compliance checks, RWA metadata, admin actions, investor reads, transaction receipts, and typed SDK errors
  • Happy-path and negative-path requirements for every test file
  • No-test justification rules (valid and invalid examples)
  • Local test commands
  • Mock client vs RPC mocks guidance
  • Test file checklist

The README is updated with a link to the new guide under the Contributing section.

Acceptance Criteria Coverage

  • Test-first contribution guide is added
  • Testing expectations for compliance checks, RWA metadata, admin actions, investor reads, transaction receipts, and typed SDK errors are documented
  • Happy-path and negative-path test expectations are included
  • No-test justification rules are documented
  • Local test commands are included
  • README links to the guide

@El-swaggerito
El-swaggerito merged commit 066d4d0 into Raegis-RWA:main Jul 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Aegis SDK test-first contribution guide

2 participants