コードへの貢献方法

Netteフレームワークに貢献しようとしていて、ルールや手順を理解する必要がありますか？この初心者向けガイドでは、コードに効果的に貢献し、リポジトリで作業し、変更を実装する方法をステップバイステップで示します。

手順

コードに貢献するには、GitHub アカウントを持ち、Gitバージョン管理システムの基本に精通している必要があります。Gitの操作に慣れていない場合は、git – the simple guide ガイドを参照したり、多くのグラフィカルクライアントのいずれかを利用したりできます。

これで、独自のコード変更を行うことができます：

各論理ステップごとに1つのコミットを作成できます。各コミットは単独で意味があるべきです。

変更に満足したら、送信できます：

あなたのコミットは他の人にも見られるようになります。コメントで指摘を受けることは一般的です：

既存のプルリクエストを修正するために新しいプルリクエストを作成しないでください。

機能性を変更したり、新しい機能を追加したりした場合は、それをドキュメントに追加することも忘れないでください。

可能であれば、最新のリリースバージョン、つまり特定のブランチの最新のタグに対して変更を行ってください。タグ v3.2.1 の場合、次のコマンドでブランチを作成します：

git checkout -b new_branch_name v3.2.1

あなたのコードは、Netteフレームワークで使用されている coding standard に準拠する必要があります。コードのチェックと修正には自動ツールが利用可能です。Composerを介して、選択したフォルダに グローバルに インストールできます：

composer create-project nette/coding-standard /path/to/nette-coding-standard

これで、ターミナルでツールを実行できるようになるはずです。最初のコマンドでチェックし、2番目のコマンドで現在のディレクトリの src および tests フォルダ内のコードを修正します：

/path/to/nette-coding-standard/ecs check
/path/to/nette-coding-standard/ecs check --fix

Netteでは、コミットの件名は次の形式です：Presenter: fixed AJAX detection [Closes #69]

プルリクエストを作成する際、GitHubインターフェースではタイトルと説明を入力できます。わかりやすいタイトルを付け、説明には変更の理由についてできるだけ多くの情報を提供してください。

また、ヘッダーも表示され、それが新機能なのかバグ修正なのか、後方互換性の破壊（BC break）が発生する可能性があるかどうかを指定します。関連する問題（issue）がある場合は、プルリクエストが承認された後に閉じられるようにリンクしてください。

- bug fix / new feature?  <!-- #issue番号、もしあれば -->
- BC break? yes/no
- doc PR: nette/docs#?    <!-- 大歓迎、https://nette.org/en/writing を参照 -->