docs: READMEにVVMファイル名の頭文字による種類分けを記載#45
Merged
Conversation
- READMEの末尾に備考セクションを追加し、VVMファイル名の頭文字によるVVMの種類分けを記載 - make_docs.pyにgenerate_notes関数を追加して自動生成に対応 - MAINTENANCE.mdに頭文字変更が破壊的変更であることを明記 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Member
Author
|
たぶん問題ないのでマージします！ |
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to clarify VVM filename prefix conventions by adding a notes section to the README. The documentation explains that VVM files are categorized by their filename prefixes: numbers for Talk, 's' prefix for Song, and 'n' prefix for Nemo.
Key Changes:
- Added automatic generation of a notes section explaining VVM filename prefix conventions
- Updated maintenance documentation to treat filename prefix changes as breaking changes
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scripts/make_docs.py | Adds generate_notes() function to generate the notes section and integrates it into the VVM documentation output |
| docs/MAINTENANCE.md | Documents that VVM filename prefix changes should be treated as breaking changes in versioning |
| README.md | Generated output includes the new notes section explaining filename prefix conventions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
内容
READMEの末尾に備考セクションを追加し、VVMファイル名の頭文字によるVVMの種類分けを記載しました。
変更内容
scripts/make_docs.pyにgenerate_notes()関数を追加し、備考セクションを自動生成するように対応README.mdに備考セクションが追加され、以下の内容が記載されます：sから始まる：ソング用nから始まる：Nemo 用docs/MAINTENANCE.mdに「VVM ファイル名の頭文字を変更した場合は破壊的変更として扱う」旨を追記関連 Issue
close #44
スクリーンショット・動画など
N/A
その他
🤖 Generated with Claude Code