Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Fail CI if a test named in the README table does not exist

Open Beginner friendly
  • Is something wrong?
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
bash, github-actions, rust
Domain
ci-cd, testing

Research direction

Start with the 'What the tests cover' table in README.md and the fn names in src/test.rs, which the script must match against. Write scripts/check-readme-tests.sh using only bash and grep, then add it as a step in .github/workflows/ci.yml. Done when the script passes on main, fails naming the old identifier after a local test rename, and passes bash -n. The 'and the five tests after it' phrase needs a decision, which the issue asks you to make and report.

Written by the indexing model from the issue text.

Description

enhancement good first issue help wanted

Written against commit 78d0a89; later commits may have moved things, so check the code first.

Size: Trivial

Description
The README has a table of "What the tests cover" that names tests (an_address_that_qualifies_and_authorizes_is_let_in_and_recorded, a_deactivated_policy_lets_nobody_in, ...). CONTRIBUTING.md welcomes "a clearer name for a test". Rename a test and the README keeps pointing at a name that no longer exists, which turns a documented claim into an unchecked one. Some entries are abbreviated with an ellipsis (an_address_below_the_minimum_…, a_policy_that_does_not_exist_… "and the five tests after it").

Current state

  • README.md "What the tests cover" table.
  • src/test.rs: 19 fn tests plus helpers.

What to build
A short script (scripts/check-readme-tests.sh, bash and grep only, no new dependency) that extracts every backticked identifier in that table, treats one ending in _… or … as a prefix, and fails naming any that matches no fn in src/test.rs. Run it from CI. Decide how to treat the "and the five tests after it" phrase (suggest rewriting it to list the names) and say what you did.

Acceptance criteria

  • The script passes on main today.
  • Renaming a test locally makes it fail with the old name in the message.
  • It runs as a step in .github/workflows/ci.yml.
  • bash -n passes.

Out of scope
Checking that the README's description of each test is accurate.

Verification
Run it, rename a test, run it again, revert.

Dominant language
Rust
Stars
2
Forks
2
Avg merge
49m
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Sorogate/example-consumer

All issues in Sorogate/example-consumer

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.