Skip to content

Add Aegis Contracts CI pass requirement guidance #142

Description

@El-swaggerito

Description

Difficulty: Hard

Type: Documentation

Summary

Add guidance explaining CI pass requirements for Aegis Contracts PRs.

Current Behaviour

Contributors may believe that a PR with failing checks can still be considered complete after merge.

Expected Behaviour

The repo should clearly state that failing CI can affect evaluation and contributors are expected to fix failing checks before approval.

Suggested Implementation

Document common CI failures, local reproduction commands, fix expectations, and reviewer responsibilities.

Files or Areas Likely Affected

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

Acceptance Criteria

  • CI pass requirement guidance is added.
  • Guidance states that failing CI can affect evaluation.
  • Common failure types are listed.
  • Local reproduction commands are included.
  • Contributor fix expectations are documented.
  • README links to the guidance.

Additional Notes

This directly addresses the issue of PRs with failing checks.

Metadata

Metadata

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelaegisAegis RWA Protocol related workciCI and workflow workdocumentationDocumentation workexpertExpert difficultyrwa-contractsRWA smart contract work

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions