docs/quality/rules.md: the rules learned from review, and the two-rounds rule
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Start with docs/README.md and docs/quality/gates.md, then review issue #316 for the report-only check counts. Create docs/quality/rules.md with sourced rules, link it from both pages, and add the two-rounds guidance and counts to the gates page. Done when the requested page, links, line, and counts are present.
Written by the indexing model from the issue text.
Description
What needs doing
- A short page,
docs/quality/rules.md: one line per rule that a
review or a failure has taught us, each with the pull request or
issue it came from. A rule that a check now enforces names the
check. - One line on
docs/quality/gates.md: after two red CI rounds on
the same pull request, stop and rethink the change before a
third push. - On the gates page, for each report-only check, the number of
right findings and false alarms measured so far (see #316).
Why
The same review finding should not have to be made twice. A written
rule can become a check; an unwritten one is forgotten.
Done when
- The page exists and is linked from
docs/README.mdand from
the gates page. - The gates page has the two-rounds line and the counts.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 197
- Avg merge
- 5h 19m
- Merged PRs (30d)
- 76
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from inferstep/ATLAS
-
area/install reliability
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Installer and setup guide: say what the docker group givesPossibly taken A pull request linked to this issue is open or already merged. Openarea/install documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
area/install reliability status/ready
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area/cli
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
area/proxy reliability status/ready
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
RedHatQE/mtv-api-tests#721 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
pytest-dev/pluggy#757 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
NousResearch/hermes-agent#134960 ·
Maintainers usually reply within 1 day
-
HTML backend: `<br>` leaks the internal sentinel U+E000 into list items, headings and captionsPossibly taken @morten-lagabote claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
docling-project/docling#4671 ·
Maintainers usually reply within 1 day