MyMaid4 の開発に興味を持っていただいてありがとうございます！
私たちのプロジェクトにコントリビュートする前に、以下の文書をお読みください。
MyMaid4 にコントリビュートするには、以下の条件を満たす必要があります。
- jao Minecraft Server で活動したことがあり、運営方針等を理解していること
- jao Minecraft Server のサーバルールなどに違反しておらず、各種処罰を行われていないこと
開発に関する環境情報です。
- IDE: IntelliJ IDEA (お勧め)
- Language: Java 17
- Package Manager: Maven
Eclipse などでも開発できますが、開発のサポートやテストサーバの動作は IntelliJ IDEA のみ対応します。
原則、コミットのメッセージやプルリクエストのメッセージなどは日本語で記述してください。
プロジェクトのタスク管理ボードとして GitHub の Project 機能 を使用しています。
このプロジェクトでは、以下のプロセスに則り開発を進めます。
- 全ての開発作業は各ユーザーのフォークリポジトリで行います。
- 実施した開発内容は動作テストを行い、期待通りにエラーなく動作することを確認してください。
- 1 つのコマンド・1 つの機能を制作し終え、本番環境に反映しても構わない場合はオリジナルリポジトリである jaoafa/MyMaid4 にプルリクエストを送信してください。
- 送信されたプルリクエストはコードオーナーによってコードをチェックされ、問題がなければマージされます。問題がある場合はプルリクエストのレビュー・コメントにて、その旨を記載しますので応答・修正して下さい。
開発を行う前に、 MyMaid4 の Wiki の開発者向け記事 をご覧ください。
ここには、MyMaid4 を開発するために必要となるであろう様々な情報がまとめられています。
開発にあたり、次の注意事項をご確認ください。
本プロジェクトの大まかなフォルダ構造は以下の通りです。
- 全てのコマンドは
src/main/java/com/jaoafa/mymaid4/command/Cmd_<CommandName>.javaに作成される必要があります。 - 全てのイベント駆動の機能は
src/main/java/com/jaoafa/mymaid4/event/Event_<FuncName>.javaに作成される必要があります。 - コマンドは コマンドフレームワーク Incendo/cloud を使用しています。
config.ymlで設定される設定情報はMyMaidConfigにあり、Main.getMyMaidConfig()から取得できます。- 複数のクラスにわたって使用される変数は
MyMaidDataに変数を作成し、 Getter と Setter を使用して管理してください。 - 複数のクラスにわたって多く使用される関数は
MyMaidLibraryに関数を作成し、Javadoc を書いたうえでextends MyMaidLibraryして利用してください。 - データベースは jaoMain と ZakuroHat の二つがありますが、原則 jaoMain
が使用されます。それぞれ
MyMaidData.getMainMySQLDBManagerMyMaidData.getZKRHatMySQLDBManagerで取得できます。 - 開発サーバかどうかは
MyMaidConfig.isDevelopmentServer()で判定できます。plugins/MyMaid4/this-server-is-developmentファイルの存在有無で確認しています。 - 全てのコマンドのパーミッションノードは小文字の
mymaid.<CommandName>でなければなりません。このパーミッションノードは自動で付与されます。
- コマンド・機能の開発を始める前に、次の作業を実施することを強くお勧めします。
upstream/masterからブランチを作成するなどを行い、最新の状態から開発する- Projects で、該当する看板があれば
In Progressに移動する - 該当する Issue の
Assigneesに自分を追加する
- ローカル変数はなにかしらの理由がある場合を除き小文字で始めてください。
- 将来的に追加・修正などを行わなければならない項目がある場合は、
// TODO <Message>で TODO を登録してください。
- 使用しているコマンドフレームワークは Incendo/cloud です。
- ドキュメントは こちら です。
- 全てのコマンドは
src/main/java/com/jaoafa/mymaid4/command/Cmd_<CommandName>.javaに配置され、これらが自動で読み込まれます。 - 同時に、クラス名は
Cmd_<CommandName>でなければなりません。<CommandName>は大文字・小文字を問いません。 - また、ここに配置されるコマンドクラスは
com.jaoafa.mymaid4.lib.CommandPremiseインターフェースを実装する必要があります。（implements CommandPremise） - コマンドを実行したユーザーにメッセージを送る場合は
MyMaidLibraryにあるSendMessageメソッドを利用してください。 - コマンドの情報（コマンド名・説明）は
details()で定義します。 - コマンドの内容は
register()で定義します。このメソッドは Main クラスのregisterCommandから呼び出され、コマンドが追加されます。（plugin.ymlに書く必要がありません）
- 全てのイベント駆動の機能は
src/main/java/com/jaoafa/mymaid4/event/Event_<FuncName>.javaに配置され、これらが自動で読み込まれます。 - 同時に、クラス名は
Event_<FuncName>でなければなりません。 <FuncName>は自由で構いません。- また、ここに配置されるコマンドクラスは
org.bukkit.event.Listenerとcom.jaoafa.mymaid4.lib.EventPremiseインターフェースを実装する必要があります。（implements Listener, EventPremise） - そのクラス(イベント)が持つ機能の情報は
description()で定義します。
- 発生しているエラーなどはコミット・プルリクエスト前にすべて修正してください。
コミットメッセージは CommitLint のルール である以下に沿っていることを期待しますが、必須ではありません。
- 次の形式でコミットメッセージを指定してください:
type(scope): subject(e.g.fix(home): message)type,subjectは必須、scopeは必須ではありません
type-enum:typeは必ず次のいずれかにしなければなりませんbuild: ビルド関連ci: CI 関連chore: いろいろdocs: ドキュメント関連feat: 新機能fix: 修正perf: パフォーマンス改善refactor: リファクタリングrevert: コミットの取り消しstyle: コードスタイルの修正test: テストコミット
type-case:typeは必ず小文字でなければなりません (NG:FIX/ OK:fix)type-empty:typeは必ず含めなければなりません (NG:test message/ OK:test: message)scope-case:scopeは必ず小文字でなければなりません (NG:fix(HOME): message/ OK:fix:(home): message)subject-case:subjectは必ず次のいずれかの書式でなければなりませんsentence-case,start-case,pascal-case,upper-casesubject-empty:subjectは必ず含めなければなりません (NG:fix:/ OK:fix: message)subject-full-stop:subjectは.以外で終えてください (NG:fix: message./ OK:fix: message)
- 必ずフォークして開発してください
- 必要がある場合、ブランチは機能追加・修正などに応じて分けて作成してください
- ブランチ名は機能追加・修正の内容を示す言葉で構成してください（例:
add-test-command,fix-test-command-api-url） - master ブランチへの直接コミットはできません
- 全てのコード追加はプルリクエストを必要とします
- Tomachi に限りセルフマージを可能とします
- レビューはほぼすべてを Tomachi が行います
master ブランチ = メインサーバ導入ソースコード です。
- コミットされると、GitHub Actions によってビルドが実施されます。失敗した場合、jMS Gamers Club
#github-noticeに通知が飛びます。 - コミットされると、メインサーバでビルドされビルドに成功すれば本番環境の
MinecraftServerDir/plugins/update/にビルド成果物が配置されます。再起動時に自動的にアップデートされます。 - バージョン表記は本番環境でのビルド処理によって、
yyyy.mm.dd_hh.mm_最終コミットsha8桁に変更されます。
コードの品質や安全性、依存パッケージを管理し一定以上に保つため、以下のサービスを利用しています。
- CodeQL: GitHub によるの静的アプリケーションセキュリティテスト (SAST) です。Push / Pull Request 時にチェックされます。
- GitHub Security Advisories: GitHub によるリポジトリセキュリティ脆弱性検知ツールです。
- Dependabot: GitHub による依存パッケージ脆弱性管理サービスです。
- Renovate: WhiteSource による依存パッケージバージョン管理ツールです。自動でアップデートを収集し、Pull Request を作成します。
- CodeFactor: 静的コード解析サービスです。Push / Pull Request 時にチェックされます。master ブランチのレポートは こちら にあります。
- Qodana: IntelliJ によるコード品質管理ツールです。Push / Pull Request 時にチェックされます。master ブランチのレポートは こちら にあります。
不明な点は jMS Gamers Club の #development チャンネルなどで質問してください。
プロジェクトにコントリビュートするすべての人々は、行動規範 を読み遵守しなければならないことを忘れないでください。