docs: issueの自動クローズについてより伝わりやすい文面の提案 #2613
Merged
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.
内容
CONTRIBUTING.mdに、issueのクローズについて以下の説明があります。
この文章を読んだコントリビューターがGithubの仕様に詳しくない場合、以下のように勘違いしてしまう可能性があると思います。
close #0000
と書いてPRを作成したタイミングで自動的に #0000 がクローズされる?(実際は作成時ではなくマージされたタイミングで自動的にクローズされる)実際に私が2の勘違いをして、close #0000 と書くことができませんでした。
なので上記のような勘違いを起こさないような文面にしたほうがよいのではないかと思い、提案としてPR作成させていただきました。
ついでに「凡そ」は開いた方が読みやすそうだったのでそれもPRに含めました。
関連 Issue
スクリーンショット・動画など
その他
「今のままでも十分伝わりやすい」とか「修正するならこう書いた方がよい」など
ご意見いただけると幸いです。