Issue #15 Provide templates for contributions

[ogis-miyamura]

Issue #15 Provide templates for contributions

Analysis

関係者が価値ある作業に注力できるよう、定型的な作業はできるだけ単純化したいです。
IssueやPull-Requestの見出しや体裁を揃えることに割く時間を減らし、コードをより良くする時間に振り替えられたら幸いです。
副次的な効果として、IssueやPull-Requestの質が揃うことで可読性が上がること、GitHubコミュニティプロファイルの評価が上がることを期待しています。

Solution

GitHubから提供されるテンプレート機能を利用する

• 「.github」ディレクトリ配下に、規定の名前のテキストファイルを格納する

重要と考えられる3種を作成した

1. Bug-Issue (bug-report.md)
2. Feature-Issue (feature-request.md)
3. Pull-Request (PULL_REQUEST_TEMPLATE.md)

ガイドライン的な文章はコメントタグとして埋め込んだ

下記理由から、この方式が利便性が高いと考えました。

• コメントタグは編集中のみ表示され、確定すると非表示となる
• 文字列として埋め込む方式と比べ、「まず削除」の手間が無くなる
• うっかり必要な箇所まで削除しすぎるリスクも減少する

部分的に、英語文と日本語文を併記した

コミュニティの性質上、日本語圏の方が多く参加されると想定され、「予備知識が無くても方針を汲み取りやすいこと」を重視しました。

• 英語文のみだと、英語が不得手な方は見落とす可能性が高いと考えた
• 「タイトル欄は英語で記入頂きたい」旨だけは、日本語も併記した
• その他は、日本語OKの項目は日本語も併記、英語のみの項目は英語のみとした

Testing

1. テキスト内容をクリップボードへコピーする
2. 新規Issueや新規Pull-Requestを起票し、テキスト入力欄へペーストする

Regression testing

個人アカウントのリポジトリにて動作確認しました。

[tsujiguchitky]

気づいた点は Compatibility のみです。そのほかは問題ないと思います。

[tsujiguchitky]

Compatibility の英語の説明が Performance の内容になっています。

[ogis-miyamura]

誤記を修正しました。ご指摘ありがとうございます。