CONTRIBUTING-ja.md

English

コントリビューションガイド

Delirはいつでもコントリビューションを歓迎しています(╹◡╹✿)
コントリビューションには以下のものを含みます。

• バグ報告
• 新機能のリクエスト
  • ポストエフェクトAPIの新機能も含みます
• バグ修正
• ポストエフェクトの開発
• など…

バグ報告 / 新機能のリクエスト

バグ報告や新機能のリクエストを受け付けています 🌟
GitHub上で気軽にIssueを立ててください。

バグ修正

バグ修正に関するプルリクエストも受け付けています 🐛
後述するコーディング規約に沿った修正パッチをGitHub上から送ってください。

送られたプルリクエストをレビューし、問題がなければマージします。
バグ修正のリリース時期は、その重要性に応じて判断します。

新機能のプルリクエスト

新機能のPull Requestを行う前に機能リクエストのIssueを送ってください。もしかしたら、私達が既にその機能に取りかかっているか、大きなリファクタリングを控えているなど、新機能を開発するのに適切なタイミングではないかもしれません。

私達はIssueを受け取り、機能の是非についての議論や実装タイミングのトリアージを行います。Issueを送る前に送られた新機能のプルリクエストに関しては、クローズする場合があることをご了承ください。

ポストエフェクトの開発

ポストエフェクトの開発も受け付けています 🌈
ポストエフェクトの追加に関しては以下のフローにのっとり、プルリクエストをお送りください

• Delirをフォークする
• packages/contrib-posteffect にポストエフェクトのディレクトリを作る
  • package.jsonの name フィールドと同じ名前のディレクトリを作成してください
• 作成したディレクトリ以下に、ポストエフェクトのコードとpackage.jsonを配置する
  • npmの package.json の形式に準拠してください。
    • nameフィールドはDelirのリポジトリ内でユニークになる名前にしてください。
  • author フィールドへのメールアドレスの記載は不要です。代わりにTwitterアカウントのURLなど、あなたに連絡が取れるURLを記述してください 例: delirvfx (https://twitter.com/delirvfx)
  • ディレクトリ直下に index.ts があるようにしてください
• ブランチを作成し、Delirにプルリクエストを作成する
• Delirチームメンバーがコードレビューを行い、問題なければマージされます

マージされたコードは、package.engines['@delirvfx/core']の追従程度の保守を行います。
新機能の追加や、技術的に追従が難しくなってしまったプラグインに関しては保守の対象から外してしまうので、必要であればプラグインへの修正プルリクエストを送ってください。

コーディング規約

原則、プロジェクトに設定されているLinterの設定に準拠してください。
また、言語は（シェーダーを除いて）TypeScriptを利用してください。（JavaScriptコードは受け付けていません）

Delirではコミット時に prettier, tslint, sass-lint による自動コードフォーマットを有効化しています。
新しい構文によりLinterが適切に機能しない場合など、Linterが利用不可能な場合などはgit commit --no-verifyによるコミットを許可しています。

免責事項

ここに記載された事項は予告なく変更することがあることをご了承ください