chore: rename .github docs to kebab-case and improve content#4
Merged
LucienSong merged 5 commits intomainfrom Mar 23, 2026
Merged
chore: rename .github docs to kebab-case and improve content#4LucienSong merged 5 commits intomainfrom
LucienSong merged 5 commits intomainfrom
Conversation
Co-authored-by: LucienSong <44640337+LucienSong@users.noreply.github.com> Agent-Logs-Url: https://github.com/ShellDAO/shell-chain/sessions/3fb7d945-c14d-4037-81ea-a8df71a1a49a
Copilot
AI
changed the title
[WIP] Rename and review .github documentation files for naming consistency
chore: rename .github docs to kebab-case and improve content
Mar 23, 2026
Co-authored-by: LucienSong <44640337+LucienSong@users.noreply.github.com> Agent-Logs-Url: https://github.com/ShellDAO/shell-chain/sessions/26fd75b0-11e4-4544-9fa5-792c6aa4b958
… HEAD commit only Co-authored-by: LucienSong <44640337+LucienSong@users.noreply.github.com> Agent-Logs-Url: https://github.com/ShellDAO/shell-chain/sessions/26fd75b0-11e4-4544-9fa5-792c6aa4b958
11 tasks
11 tasks
LucienSong
added a commit
to LucienSong/shell-chain
that referenced
this pull request
Mar 25, 2026
…s-to-kebab-case chore: rename .github docs to kebab-case and improve content
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.
REVIEW_CHECKLIST.md→review-checklist.mdwith content improvementsRUST_CRYPTO_REVIEW.md→rust-crypto-review.mdwith content improvementsPR_REVIEW_TEMPLATE.md(content merged intopull_request_template.md)pull_request_template.mdwith improved contentpr-review.ymlheader comments to reference new kebab-case filenamesreview-checklist.md§7 to document the new policyOriginal prompt
Task: Rename and review
.githubdocumentation files for naming consistencyContext
PR #2 (branch:
copilot/add-github-actions-pr-review-workflow) is currently adding new files using kebab-case naming:.github/workflows/pr-review.yml.github/pull_request_template.mdBut the existing
.githubfiles use UPPER_SNAKE_CASE naming, which is inconsistent. We need to align all file names to a consistent convention.Current files in
.github/:CODEOWNERS— Keep as-is (this is a GitHub-required standard name)PR_REVIEW_TEMPLATE.md— Needs renamingREVIEW_CHECKLIST.md— Needs renamingRUST_CRYPTO_REVIEW.md— Needs renamingRequirements
1. File Renaming (use kebab-case to match the new workflow files)
CODEOWNERSCODEOWNERSPR_REVIEW_TEMPLATE.mdpull_request_template.md(which PR #2 will create). If PR #2 hasn't created it yet, create.github/pull_request_template.mdwith improved content (see below).REVIEW_CHECKLIST.mdreview-checklist.mdRUST_CRYPTO_REVIEW.mdrust-crypto-review.md2. Content Review and Improvement for
review-checklist.md(renamed fromREVIEW_CHECKLIST.md)Current content has some issues to fix:
_character after the closing parenthesis:(e.g., ownership, borrowing)._— remove the stray underscore.github/workflows/pr-review.yml)2026-03-233. Content Review and Improvement for
rust-crypto-review.md(renamed fromRUST_CRYPTO_REVIEW.md)Current content review:
rust-crypto(which is unmaintained) withRustCryptocrate family (e.g.,sha2,aes,ed25519-dalek) — the project already usesed25519-dalekringas an alternative (already mentioned, good)cargo auditregularlycargo auditon every PR2026-03-234. Create or Improve
.github/pull_request_template.mdIf this file doesn't exist yet (PR #2 may or may not have created it), create it by merging the best parts of the old
PR_REVIEW_TEMPLATE.mdwith improvements:5. Important Notes
mainbranchPR_REVIEW_TEMPLATE.md, make sure its useful content is preserved inpull_request_template.mdpull_request_template.mdshould point to the new kebab-case filename.github/rust-crypto-review.mdCODEOWNERSexactly as-is (content:* @LucienSong)The following is the prior conversation context from the user's chat exploration (may be truncated):
User: 看看项目创建的自动化审核PR脚本和文档,好像不全,也不是我想要的。我想要一个当有PR提交或修改时自动触发的审核脚本
Assistant:
Let me first look at the existing automation scripts and documentation in the repository.
Assistant: 我已经查看了项目中所有现有的审核相关文件。以下是现状分析:
📋 现有文件分析
你的仓库目前有以下 PR 审核相关文件:
.github/PR_REVIEW_TEMPLATE.md.github/REVIEW_CHECKLIST.md.github/RUST_CRYPTO_REVIEW.md.github/CODEOWNERS@LucienSong)scripts/pr-review-checks.shThis pull request was created from Copilot chat.
⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.