開発に参加する
ngx_mrubyへの変更はGitHubのプルリクエストで受け付けています。人もコーディングエージェントも手順は同じです。このページでは、変更の対象ブランチとPRに必要なものを説明します。ルールの全体はAGENTS.mdにあります。エージェントは作業の前にAGENTS.mdを読みます。人が作業するときも、ルールの基準はAGENTS.mdです。
変更の対象ブランチ
Section titled “変更の対象ブランチ”| 変更 | ベースブランチ |
|---|---|
| 2.xのクラッシュ、ハング、リーク、ビルド失敗の修正 | v3.0.0でv3がmasterになるまではmaster |
| 新しい挙動、ディレクティブやメソッドの追加、APIの整理、その他v3の作業 | next |
2.xでは互換性を最優先にし、設定、スクリプト、ビルドから見える挙動は不具合の修正に必要な範囲だけ変えます。v3にも必要な修正はmasterへ送り、masterからnextへのマージで取り込みます。各ブランチの役割は、Branch strategyの説明を参照してください。
セキュリティの脆弱性は公開のissueやPRに書かず、SECURITY.mdの手順で非公開で報告してください。修正も非公開で準備します。
PRに必要なもの
Section titled “PRに必要なもの”- PRテンプレートの全項目を記入し、該当しない項目には「n/a」と書きます。
- コードを変える場合は、実際のレスポンスを検証するテストを
test/に追加します。できればtest/conf/conf.d/にserverのフラグメント、test/html/にスクリプト、test/t/cases/にケースを置いてください。書き方はテストを参照し、sh test.shでスイートを実行します。ドキュメントだけの変更にはテストの追加は不要です。 - 不具合の修正は2コミットに分けます。最初のコミットで回帰テストを追加し、失敗することを確認します。次のコミットで修正を加え、テストを通します。各コミットでのスイートの結果をPRに記載してください。
- 設定、スクリプト、ビルドから見える変更には、
docs/releases/<version>.mdの「Behavior changes: read before upgrading」と、日本語版のdocs/releases/<version>.ja.mdに同じエントリーを追加します。詳細はリリースノートを参照してください。 - ディレクティブ、Rubyのメソッド、ビルドオプション、テストハーネスを変える場合は、
docs/の説明も更新します。 src/、mrbgems/、ビルドを変える場合は、AGENTS.mdの「Design principles」に従って性能を比較します。
レビューとマージ
Section titled “レビューとマージ”PRの作者以外が、AGENTS.mdの「Review and merge」のチェックリストに沿ってレビューし、指摘をコメントに残します。headのコミットでCIが通り、レビューの「must fix」の項目がすべて解決し、その他の条件もすべて満たしてから、マージコミットで取り込みます。タグ、リリース、セキュリティアドバイザリはオーナーが管理します。
質問、セキュリティ以外の不具合、提案はGitHubのissueに投稿してください。v3の大きな計画はdocs/proposals/、作業状況はdocs/HANDOFF.mdにあります。