Skip to content

Conversation

nanae772
Copy link
Contributor

@nanae772 nanae772 commented Mar 15, 2025

内容

CONTRIBUTING.mdに、issueのクローズについて以下の説明があります。

議論する場所が分散する事を防ぐため、Pull Requestするタイミングで問題提起した方の番号を閉じましょう。コメントに下記のような表記をすることでIssue側の議論を閉じることができます。

  close #0000

この文章を読んだコントリビューターがGithubの仕様に詳しくない場合、以下のように勘違いしてしまう可能性があると思います。

  1. Pull RequestするタイミングでIssueを自分でクローズすればよい?(実際は権限的にできない)
  2. Pull Requestに close #0000 と書いてPRを作成したタイミングで自動的に #0000 がクローズされる?(実際は作成時ではなくマージされたタイミングで自動的にクローズされる)

実際に私が2の勘違いをして、close #0000 と書くことができませんでした。
なので上記のような勘違いを起こさないような文面にしたほうがよいのではないかと思い、提案としてPR作成させていただきました。

ついでに「凡そ」は開いた方が読みやすそうだったのでそれもPRに含めました。

関連 Issue

スクリーンショット・動画など

その他

「今のままでも十分伝わりやすい」とか「修正するならこう書いた方がよい」など
ご意見いただけると幸いです。

@nanae772 nanae772 requested a review from a team as a code owner March 15, 2025 01:33
@nanae772 nanae772 requested review from Hiroshiba and removed request for a team March 15, 2025 01:33
@voicevox-preview-pages
Copy link

🚀 プレビュー用ページを作成しました 🚀

更新時点でのコミットハッシュ:5f937dc

@nanae772 nanae772 changed the title docs: issueの自動クローズについてより伝わりやすいように修正 docs: issueの自動クローズについてより伝わりやすい文面の提案 Mar 15, 2025
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

確かにタイミングが分かりにくかったと思います!
非常に分かりやすいドキュメントで良いと思います!!

📝 判断メモ
以前の案内では「PR時点でissueを閉じて」という内容だったのですが、VOICEVOX全体の実態に合わせてPRをクローズした時にissueもクローズする形にしたいと思います。
これは正直どっちがいいか若干わからないのですが、とりあえず実態に合わせた形です。
また運用は課題に思った時に考えてもいいかも!

@Hiroshiba Hiroshiba enabled auto-merge March 15, 2025 13:46
@Hiroshiba Hiroshiba added this pull request to the merge queue Mar 15, 2025
Merged via the queue into VOICEVOX:main with commit 50f8b23 Mar 15, 2025
11 checks passed
@nanae772 nanae772 deleted the update-contributing branch March 15, 2025 14:39
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