CONTRIBUTING.md を実態に合わせて整備する
背景
現行の CONTRIBUTING.md は内容が非常に簡素で、実際の開発に必要な情報が不足している。主な問題点:
- リポジトリURL: GitHub(https://github.com/FrontISTR/FrontISTR) を参照しているが、開発はGitLabで行われている
- マニュアルURL: 同様にGitHub上のリポジトリを参照している
- 誤記: "Folking" → "Forking"、"reposito ry" → "repository"
- テスト手順:
make testのみ記載されており、現在のCMake/ctestベースのテスト手順が記載されていない - 開発ガイドラインの欠如: コーディング規約、ブランチ戦略、コミットメッセージ規約、レビュープロセス、外部依存ライブラリのポリシー等が未記載
- CI/CDの説明の欠如: パイプラインの構成やテストの通過基準が記載されていない
#737 (closed) / !534 (merged)(外部依存ライブラリのインクルードパス問題)を契機に、新規開発者・貢献者が参照すべき技術的ガイドラインの必要性があらためて認識された。CONTRIBUTING.md を実態に合わせて整備し、開発上のポリシーを明文化することを提案する。
CONTRIBUTING.mdに全部まとめると長くなるようなら、DEVELOPERSGUIDE.mdのような子ファイルを作ってそこを参照させてもよい。