AniNIX/Uniglot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

WIP: Add a test to ensure READMEs #3

Closed
DarkFeather wants to merge 0 commits from README-test into main
pull from: README-test
merge into: :main
Conversation 1 Commits - Files Changed -
DarkFeather commented 2023-02-22 22:51:26 -06:00
Owner
Copy Link
Copy Source

We should add a test to ensure that all projects have a README.md that meets minimum standards for sections or has a See [text](link) grok for the sole content.

AniNIX/Ubiqtorate will need a pre-commit hook of its own for recursive README's, and it should be able to consume this one by passing the found READMEs in as an argument.

This will allow our AniNIX/Wiki to also ensure certain pages meet these standards and will provide a good baseline for documentation from that original location.

We should add a test to ensure that all projects have a `README.md` that meets minimum standards for sections or has a `See [text](link)` grok for the sole content. [AniNIX/Ubiqtorate](/AniNIX/Ubiqtorate) will need a pre-commit hook of its own for recursive README's, and it should be able to consume this one by passing the found READMEs in as an argument. This will allow our [AniNIX/Wiki](/AniNIX/Wiki) to also ensure certain pages meet these standards and will provide a good baseline for documentation from that original location.
DarkFeather self-assigned this 2023-02-22 22:51:27 -06:00
DarkFeather closed this pull request 2023-11-09 13:16:16 -06:00
DarkFeather commented 2023-11-09 13:17:16 -06:00
Author
Owner
Copy Link
Copy Source

Done in c988f725fb.

Done in c988f725fb8061f483f460684b2fdafa2c3b1675.

Pull request closed

This pull request cannot be reopened because the branch was deleted.
This pull request is marked as a work in progress.
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Blocked
There are functional or technical reasons this can't be implemented yet
 Duplicate
Another issue or PR already describes this issue
 In-progress
Being worked.
 On-hold
Evaluated but not enough resources to complete now
 Peer-review
Being reviewed for quality prior to merge
 RFC
More information and feedback is needed
 Wontfix
Not a bug -- way it works
Blocked
There are functional or technical reasons this can't be implemented yet
 Duplicate
Another issue or PR already describes this issue
 In-progress
Being worked.
 On-hold
Evaluated but not enough resources to complete now
 Peer-review
Being reviewed for quality prior to merge
 RFC
More information and feedback is needed
 Wontfix
Not a bug -- way it works
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
DarkFeather (DarkFeather)
No Assignees DarkFeather
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: AniNIX/Uniglot#3