Repository navigation
Answer late review findings on #62, #78 and #79 #85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ca461a7
Read changelog fences as CommonMark does and accept numbered entries
polewskm 310fd32
Allow a light review only for documentation files, by an allowlist
polewskm f296477
Test teach's private-repository finding, issue failures and link fall…
polewskm 6bff291
Describe the light review by its allowlist in the check run and test …
polewskm d08efe8
Define documentation once, for both the light review and the review o…
polewskm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Nit: The documentation allowlist depends on a growing list of
.txtnames to exclude F1 · architectureEvery
.txtfile counts as documentation unless its name matchespublicApiPathorlistingFile, so other machine-read.txtfiles still get classified as docs, such as license or dependency lists, test fixtures and data inputs.Consequence: Each new kind of non-prose
.txtneeds another entry here. Until someone adds it, a pull request that changes such a file gets only the light hygiene review and is ordered last when the diff is over budget. How much this matters depends on how common these files are in the target repositories.Fix: Count
.txtas documentation only by location or name, such as the repository root or doc/ and docs/. Or keep the exclusions in one shared list that the README and the tests also read.Evidence
src/gather.ts:
documentationFile = /\.(md|rst|txt)$/i, then exceptions forlistingFile(CMakeLists.txt, requirements/constraints) andpublicApiPath.Confidence 0.30.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Autopilot: declined for now: a nit on code that has already merged, after three review rounds on this chain. The point stands:
.txtcounts as documentation everywhere except the named exclusions. Narrowing.txttodoc/,docs/and the repository root (or one shared exclusion list that the README and tests read) is now an item in the follow-up checklist #84.