maven - github マークダウン ファイルを Maven サイトに含める方法

Question

Github では、README.md、LICENCE.md、CONTRIBUTORS.md などの Markdown 形式のファイルをプロジェクトのルートに作成することを推奨しています。一方、これらのファイルは、自動生成された Maven サイトにとって価値のあるコンテンツになります。

これらのファイルを生成されたサイト レポートに含めるベスト プラクティスは何ですか?

私が持っていたアイデアの 1 つは、それらを src/site/markdown にコピーし、サイト生成が成功した後に再度削除することでした (SCM 汚染を避けるため)。

Answer 1

コントリビューターはpomに入れる必要があります。ライセンス ファイルは、Apache が提案したように、通常は LICENSE.txt を pom.xml ファイルの兄弟としてプロジェクトの一部にする必要があります。README.txt も Apache によって提案されています。README.md は通常、リポジトリの表示中に GitHub がこれをレンダリングするためにのみ価値があります。