このプロジェクトへの貢献をお考えいただきありがとうございます！
変更を加えたりPRを出したりする時は以下のことを守ってください
バグ報告はIssueを立てるかDiscordサーバーでお願いします
編集する時やプルリクエストを送る時はdevブランチを使います。基本的にmainには直接コミットしないでください。
アプデ対応やらバグ発見やらが超楽になるのでJSDocはつけてほしいです
npm iでマイクラの型定義などをインストール
バージョンに合った型定義を入れてください バージョン一覧- 編集できたら
npm run lintでeslintとtscが通るか確認。だめだったら直してください。
- devからmain
git switch mainでmainに移動git pullで最新の変更を取得(一応)
git merge devでマージ
git pushで変更内容をプッシュします
git switch devでdevに戻っておきます(mainにpush誤爆防止)
- 開発ブランチ
devからmainに変更内容をマージ(上参照) - GithubでReleaseを作成
書き方は前のバージョンのものに従ってください。
Assetsのmcpackは自動でアップロードされるので触らなくて大丈夫です
x.y.z
x: 大きな変更がある(コード丸ごと書き直しなど)の時に上げます。基本そのままです
y: マイクラのバージョンが上がったら(=アプデ対応の時)上げます
z: 小さな変更やバグ修正がある時上げます
- バージョンを上げる時はmanifestを4箇所, package.jsonを1箇所, util/constantsを1箇所編集します
- クラスに新しくプロパティ生やす時は
scripts/types.d.tsに定義を追加してください - コマンドの追加は
commands/index.jsでしてます - イベントのsubscribeは基本
ac.js内で行います - Configに変更があるリリースの場合は1番上のConfigVersionを1上げておきます(変更があったことを分かりやすくする)
- Configに値を追加したら
util/config_descriptionに値の説明を書きます(ConfigPanelで表示する用)