docs: add README standardization template and automation helper#1561
Open
SH20RAJ wants to merge 1 commit intomofa-org:mainfrom
Open
docs: add README standardization template and automation helper#1561SH20RAJ wants to merge 1 commit intomofa-org:mainfrom
SH20RAJ wants to merge 1 commit intomofa-org:mainfrom
Conversation
Contributor
Author
|
Quick follow-up: this PR adds reusable README standardization assets (.github/README_TEMPLATE.md and .github/scripts/standardize_readme.py) plus a minimal proof-of-concept normalization in README_cn.md. Happy to further narrow scope if you want template-only in this PR and PoC in a separate one. |
Contributor
Author
|
@maintainers - Quick follow-up on README standardization. Would appreciate input on scope preference:
Let me know! 📋 |
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
1 participant
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
.github/README_TEMPLATE.mdfor consistent repository README structure.github/scripts/standardize_readme.pyto check required sections and normalize community linksREADME_cn.md(GitHub Discussions label consistency)How to use
python3 .github/scripts/standardize_readme.py --check README.md README_cn.mdpython3 .github/scripts/standardize_readme.py --write README_cn.mdIssue
Fixes #232