Skip to content

docs: surface CI pass requirements earlier in README - #153

Merged
El-swaggerito merged 1 commit into
Raegis-RWA:mainfrom
bonaventure001:docs/ci-pass-requirement-guidance
Jul 29, 2026
Merged

docs: surface CI pass requirements earlier in README#153
El-swaggerito merged 1 commit into
Raegis-RWA:mainfrom
bonaventure001:docs/ci-pass-requirement-guidance

Conversation

@bonaventure001

Copy link
Copy Markdown
Contributor

Context

While working on #142, I found that comprehensive CI pass requirement
guidance already exists in this repo:
docs/failing-ci-guide.md — covering failure categories (Rust
compilation, Soroban, Makefile, dependency, workflow dispatch), local
reproduction commands, and maintainer expectations, and it's already
linked from the README.

Rather than duplicate that work, this PR addresses a real, smaller gap:
discoverability. The only README link to the guide was buried far
down the page, and the Testing section (the natural first stop for a
contributor about to push) had no pointer to it at all.

Changes

  • Added a note in the Testing section pointing to make verify and the
    Failing CI Response Guide, visible before a contributor pushes
  • Added a quick-reference failure-type table in the CI & Contributing
    section for fast scanning, alongside the existing detailed prose guide

Acceptance criteria mapping

  • CI pass requirement guidance exists — already present in
    docs/failing-ci-guide.md (pre-existing)
  • States failing CI can affect evaluation — already present
  • Common failure types listed — already present in prose; this PR
    adds a scannable table version
  • Local reproduction commands included — already present
  • Contributor fix expectations documented — already present
  • README links to the guidance — already present at one location;
    this PR adds a second, earlier pointer for discoverability

Note for reviewers

This is intentionally a small, honest PR. The substantive guidance was
already built; I did not want to pad this out or duplicate existing
content just to appear more substantial. Happy to expand scope if a
maintainer identifies a genuine remaining gap.

- Add a pointer in the Testing section directing contributors to run
  'make verify' before opening a PR, since the existing CI requirement
  guidance (docs/failing-ci-guide.md) was previously only linked much
  further down the README
- Add a quick-reference failure-type table in the CI & Contributing
  section for fast scanning, alongside the existing detailed guide

Note: docs/failing-ci-guide.md already covers CI failure categories,
local reproduction commands, and contributor/maintainer expectations
in depth. This PR improves discoverability of that existing guidance
rather than introducing new content from scratch.

Relates to #142
@El-swaggerito
El-swaggerito merged commit 1e7b482 into Raegis-RWA:main Jul 29, 2026
1 check 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.

2 participants