問題のガイドラインはどのようにしたらよいですか？ （Github）

Question

私は自分のリポジトリのユーザーに、問題の報告方法と提供すべき情報に関する情報を提供したいと思います。 この情報を表示するにはどのような方法が最適ですか？/issuesタブにreadmeがあることを望んでいましたが、そのようなオプションはないようです。 「問題を作成する前に読む」という名前の「問題」を作成する必要がありますか？

Answer 1

プロジェクトのルートディレクトリに混乱が生じることが心配な場合は、
CONTRIBUTING.md,ISSUE_TEMPLATE.md、PULL_REQUEST_TEMPLATE.mdのファイルをプロジェクトディレクトリに入れることができます。
はい、両方の当事者が問題を作成したり、プルリクエストが簡単にすべての情報を入力します。

この情報、および場所を提示するための最良の方法は何ですか？

この3つのファイルとファイル名は、ここと同じにする必要があります。 More information about it

Answer 2

githubがそのような機能を排他的に提供するかどうかはわかりません。別の方法として、プロジェクトのメインブランチにあるreadme.mdファイル（他のセクションと一緒に#HowToCreateAnIssueセクションなど）にガイドライン（または問題の作成方法へのリンク）を含めることもできます。少なくとも、これは私が従うものです。

Answer 3

私のプロジェクトでは（ほとんどの人がそれをどう扱うかと思います）、私はプロジェクトリポジトリにreadmeを追加し、最も重要なwikiページへのリンクを作成しました。 wikiは追加リポジトリとして管理され、必要に応じて情報や更新を保存することができます。 ウェブページを作成している場合は、投稿者として参加する方法に関する情報を追加する場所にもなります。