docs: align documentation with actual repo state - #35
Merged
Conversation
index.html was deleted from the repo, so the Repository Structure row and the GitHub Pages mention in Project Overview no longer applied. The Tips section held a single item, "Don't change the core apps unless you find a real bug", which referenced apps this template does not contain and duplicated the existing "Keep changes minimal" guideline.
Drop the Contributor Covenant file and the references to it in the README and AGENTS.md inventory tables. The Customization Checklist item pointed at a contact method in CODE_OF_CONDUCT.md, so it now names SECURITY.md instead. Note: this repo is named .github, so its root community-health files serve as account-wide defaults for repos that do not ship their own.
README and AGENTS.md each carried a table of the repo's files. They had already drifted apart: README omitted itself, AGENTS.md omitted both README.md and CLAUDE.md, and removing CODE_OF_CONDUCT.md meant editing the same row in two places. Drop the AGENTS.md table and note in Project Overview that README holds the inventory. Carry over the ci.yml detail about Node steps skipping, which only AGENTS.md recorded, and give CLAUDE.md its own row.
Add a Commit Messages section specifying type(scope): summary, reusing the types already listed for branch prefixes. Note that branch names should avoid parentheses: git accepts them, but bash and zsh parse ( as syntax, so every command touching such a branch needs quoting. AGENTS.md and the Pull Requests steps said only "descriptive message"; both now point at the new section instead of restating it.
The inventory said Node steps skip when package.json is absent, which is broader than the workflow does. actions/setup-node has no condition and runs regardless; only the npm ci and npm test steps carry the hashFiles guard.
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
Four commits bringing the docs in line with what the repository actually contains, after
index.htmlwas deleted via the web UI.docs(agents): drop theindex.htmlrow and the "starter GitHub Pages page" claim fromAGENTS.md; remove theTipssection, whose single item ("Don't change the core apps unless you find a real bug") referenced apps this template does not contain and restated the existing "Keep changes minimal" guideline.chore(coc): removeCODE_OF_CONDUCT.mdand its inventory references. TheCustomization Checklistpointed at a contact method inside it, so it now namesSECURITY.md.docs(agents): keep one file inventory, inREADME.md. Both files carried a table and they had already drifted — README omitted itself,AGENTS.mdomittedREADME.mdandCLAUDE.md, and deleting one file meant editing the same row twice. Theci.ymlnote about Node steps skipping was carried over from the dropped table, andCLAUDE.mdgained its own row.docs(contributing): document the commit convention astype(scope): summary, reusing the types already listed for branch prefixes. Records why branch names avoid parentheses: git accepts them, but bash and zsh parse(as syntax, so every command touching such a branch needs quoting.Grouped rather than split because the commits touch overlapping lines in
AGENTS.mdandREADME.md; as separate PRs a reviewer reads the same regions three times.Note: this repository is named
.github, so removingCODE_OF_CONDUCT.mdalso removes the account-wide default Code of Conduct for repos that do not ship their own. Reversible from history if unwanted.Test plan
README.mdtable lists every tracked file except itselfGreptile Summary
The README now accurately identifies the npm steps that are skipped without a package manifest and reflects the tracked repository files. The contribution guidance documents the repository’s branch and commit conventions.
Confidence Score: 5/5
No blocking failure remains.
The workflow behavior and README inventory were checked for repositories with and without a package manifest; the documented behavior matches the workflow.
What T-Rex did
Reviews (2): Last reviewed commit: "Merge branch 'master' into docs/align-do..." | Re-trigger Greptile