Skip to content

chore: rename .github docs to kebab-case and improve content#4

Merged
LucienSong merged 5 commits intomainfrom
copilot/rename-github-docs-to-kebab-case
Mar 23, 2026
Merged

chore: rename .github docs to kebab-case and improve content#4
LucienSong merged 5 commits intomainfrom
copilot/rename-github-docs-to-kebab-case

Conversation

Copy link
Contributor

Copilot AI commented Mar 23, 2026

  • Rename REVIEW_CHECKLIST.mdreview-checklist.md with content improvements
  • Rename RUST_CRYPTO_REVIEW.mdrust-crypto-review.md with content improvements
  • Delete PR_REVIEW_TEMPLATE.md (content merged into pull_request_template.md)
  • Update pull_request_template.md with improved content
  • Fix pr-review.yml header comments to reference new kebab-case filenames
  • Fix PR review CI failure: update commit-message check policy
    • HEAD (latest) commit must follow conventional commits format (hard fail)
    • Earlier intermediate commits emit warnings only — allows iterative/planning commits
    • Updated review-checklist.md §7 to document the new policy
Original prompt

Task: Rename and review .github documentation files for naming consistency

Context

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.md

But the existing .github files use UPPER_SNAKE_CASE naming, which is inconsistent. We need to align all file names to a consistent convention.

Current files in .github/:

  1. CODEOWNERSKeep as-is (this is a GitHub-required standard name)
  2. PR_REVIEW_TEMPLATE.md — Needs renaming
  3. REVIEW_CHECKLIST.md — Needs renaming
  4. RUST_CRYPTO_REVIEW.md — Needs renaming

Requirements

1. File Renaming (use kebab-case to match the new workflow files)

Current Name New Name Notes
CODEOWNERS CODEOWNERS Keep unchanged — GitHub standard
PR_REVIEW_TEMPLATE.md DELETE this file Its content should be merged into the standard pull_request_template.md (which PR #2 will create). If PR #2 hasn't created it yet, create .github/pull_request_template.md with improved content (see below).
REVIEW_CHECKLIST.md review-checklist.md Rename + review content
RUST_CRYPTO_REVIEW.md rust-crypto-review.md Rename + review content

2. Content Review and Improvement for review-checklist.md (renamed from REVIEW_CHECKLIST.md)

Current content has some issues to fix:

  • Line 17 has a trailing _ character after the closing parenthesis: (e.g., ownership, borrowing)._ — remove the stray underscore
  • Add a section for CI/CD Integration mentioning that automated checks are now run via GitHub Actions (reference .github/workflows/pr-review.yml)
  • Add a note at the top explaining this checklist is used as a reference during both manual and automated PR reviews
  • Update the "Last updated" timestamp to 2026-03-23

3. Content Review and Improvement for rust-crypto-review.md (renamed from RUST_CRYPTO_REVIEW.md)

Current content review:

  • The content is generally good but should reference more modern/recommended crates:
    • Replace recommendation of rust-crypto (which is unmaintained) with RustCrypto crate family (e.g., sha2, aes, ed25519-dalek) — the project already uses ed25519-dalek
    • Add mention of ring as an alternative (already mentioned, good)
  • Add a section about Dependency Pinning — recommend pinning cryptographic dependency versions and using cargo audit regularly
  • Add a note referencing the automated CI workflow that runs cargo audit on every PR
  • Update the "Last updated" timestamp to 2026-03-23

4. Create or Improve .github/pull_request_template.md

If 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.md with improvements:

## Overview
<!-- Provide a brief description of the changes in this PR -->

## Type of Change
- [ ] 🐛 Bug Fix
- [ ] ✨ New Feature
- [ ] 📝 Documentation Update
- [ ] ♻️ Refactor
- [ ] 🔧 Configuration/CI
- [ ] Other (please specify):

## Checklist
<!-- Review the checklist before submitting. See .github/review-checklist.md for details -->
- [ ] Code follows the project's style guidelines (`cargo fmt`)
- [ ] Code passes lint checks (`cargo clippy`)
- [ ] Unit tests have been added/modified for changes
- [ ] Documentation has been updated (code comments, README, API docs)
- [ ] No sensitive information is exposed
- [ ] Commit messages follow [conventional format](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `chore:`, etc.)
- [ ] For crypto changes: reviewed against [Rust Crypto Review Guidelines](.github/rust-crypto-review.md)

## Related Issues
<!-- Link any related issues: Fixes #123, Closes #456 -->

## Additional Notes
<!-- Any additional context, screenshots, or information for reviewers -->

5. Important Notes

  • This PR should be based on the main branch
  • When deleting PR_REVIEW_TEMPLATE.md, make sure its useful content is preserved in pull_request_template.md
  • The cross-reference link in the new pull_request_template.md should point to the new kebab-case filename .github/rust-crypto-review.md
  • Keep CODEOWNERS exactly 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 静态模板 PR 描述模板(手动填写的 checklist)
.github/REVIEW_CHECKLIST.md 静态文档 审核清单参考文档
.github/RUST_CRYPTO_REVIEW.md 静态文档 Rust 和密码学审核指南
.github/CODEOWNERS 配置 代码所有者(@LucienSong
scripts/pr-review-checks.sh Shell 脚本 本地运行的检查脚本(fmt/clippy/test/audit...

This pull request was created from Copilot chat.


⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.

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
Copilot AI requested a review from LucienSong March 23, 2026 01:59
Copilot AI and others added 2 commits March 23, 2026 02:07
@LucienSong LucienSong merged commit f1d79e3 into main Mar 23, 2026
9 checks passed
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants