Open
Conversation
29 tasks
There was a problem hiding this comment.
Pull request overview
PRテンプレート例の「Closes」表記を、プレースホルダに見えない具体例へ置き換えて、読者が意図を理解しやすくするためのドキュメント調整です。
Changes:
- PRテンプレート例の
Closes #xxxxをCloses #123に変更
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/chapters/chapter07/index.md
Outdated
|
|
||
| ## 受入条件(Issue) | ||
| - Closes #xxxx | ||
| - Closes #123 |
There was a problem hiding this comment.
この例は「このまま使える」テンプレート例として示されているため、Closes #123 をそのままコピペすると実在する Issue/PR #123 を参照(場合によってはクローズ)してしまう可能性があります。Closes #123(例) のように例である旨を併記するか、Closes #<issue-number> 等の“置き換え必須”表現にして誤操作を避けたいです。
Suggested change
| - Closes #123 | |
| - Closes #<issue-number> |
Collaborator
Author
There was a problem hiding this comment.
ご指摘ありがとうございます。
例を Closes #<issue-number> に変更し、実在の Issue を参照してしまうリスクを避けました。
Collaborator
Author
|
Copilot のインライン指摘に対応しました。
|
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.
変更内容
Closes #xxxxを、例として分かりやすいCloses #123に変更しました。背景
xxxxのままだとプレースホルダに見え、読者に「このまま使って良いのか」が伝わりにくいため。影響