docs: surface CI pass requirements earlier in README - #153
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Merged
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 (Rustcompilation, 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
make verifyand theFailing CI Response Guide, visible before a contributor pushes
section for fast scanning, alongside the existing detailed prose guide
Acceptance criteria mapping
docs/failing-ci-guide.md(pre-existing)adds a scannable table version
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.