docs: prose cleanup across AGENTS.md, README, package docstring, references#14
Open
brittanyreese wants to merge 3 commits into
Open
docs: prose cleanup across AGENTS.md, README, package docstring, references#14brittanyreese wants to merge 3 commits into
brittanyreese wants to merge 3 commits into
Conversation
main now requires PRs (CI green across 3.11/3.12/3.13, linear history, squash-merge only) - record it in Git workflow instead of leaving the doc to imply direct push still works. Also collapses the test-first and reference-value bullets that said the same thing twice, drops the redundant Conventional-Commits bullet already covered above, and removes the Gotchas section, whose two lines duplicated the Commands comment and the binding rule.
Shortens a closing sentence in the reliability section and states the package docstring as a plain description rather than an instruction.
…aphs Matches the rest of the file's one-paragraph-per-line convention; the Software section had been left mid-edit with paragraphs broken across several lines.
There was a problem hiding this comment.
Pull request overview
Docs-only prose cleanup to keep public-facing messaging and contributor guidance consistent with the project’s current positioning (reliability + DIF report card) and to improve readability in key documentation.
Changes:
- Align package tagline wording in
__init__.pywith the repository’s stated positioning. - Tighten phrasing and sentence flow in README reliability/DIF sections.
- Reflow
docs/REFERENCES.mdprose into single-line paragraphs and tidy link formatting; updateAGENTS.mdcontributor guidance.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/metajudge/init.py | Updates the package docstring tagline to the current “reliability + DIF report card” wording. |
| README.md | Minor wording/sentence-structure edits for clarity in reliability and DIF explanation sections. |
| docs/REFERENCES.md | Rewraps prose into single-line paragraphs; formats AutoRubric URLs as Markdown links. |
| AGENTS.md | Adds/edits contributor workflow guidance and deduplicates “binding rules” text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - Conventional Commits. One logical change per commit; keep formatting-only changes in their own `style:` commit (never bundle a repo-wide reformat into a feature commit). | ||
| - Trunk-based: `main` stays green and releasable. Small changes go straight to `main`; non-trivial work uses a short-lived branch merged back promptly so `main` never goes stale. | ||
| - `main` is branch-protected: PRs required (no direct push, including admins), CI green across the 3.11/3.12/3.13 matrix, linear history, squash-merge only. |
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.
Summary
Test plan