Skip to content

Latest commit

 

History

History
100 lines (61 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

100 lines (61 loc) · 4.88 KB
Raw

Contribution

English

AviUtl Package Managerデータへのコントリビュートに興味を持っていただきありがとうございます！！

コントリビュートの仕方についてガイドします。

使用言語

このデータは、JSON形式で提供されています。

使用言語:

  • JSON

Issues

以下のIssueは、テンプレートを用意しています。日本語でも英語でも構いません。

その他のIssueも大歓迎です。

Pull Requests

Pull Requestも大歓迎です。

以下のようなPull Requestを受け付けています。基本的なPull Requestは、Issueを立てなくても問題ありません。

新機能や改善、修正について、疑問がある場合や、大きな新機能や変更の影響が大きい場合は、一度Issueを立てて相談してください。

  • パッケージデータの追加
  • データ形式の変更

Pull Requestがマージされた時点で、あなたの貢献がContributorsリストに追加され、コードの内容にはCC BY-NC-SA 4.0が適用されます。

修正の確認

AviUtl Package Managerの設定タブから、データ取得先にv3フォルダを指定するか、追加データ取得先に編集したJSONファイルを指定して、追加したパッケージのインストールとアンインストールを試してください。

ディレクトリ構造

v3下にデータJSONを配置します。

└── v3
    ├── packages
    │   ├── xxxx.json
    │   └── yyyy.json
    ├── convert.json
    ├── core.json
    ├── list.json
    ├── package-sets.json
    ├── packages.json
    └── scripts.json

コミットメッセージ規約

現状、更新履歴を出力することが無いので明確に規定していませんが、AngularのCommit Message Formatに従うとよいでしょう。

データの書き方・ルール

まずは、仕様書を確認します。

その他、慣例的に行っていることを記します。

  • パッケージは、IDでアルファベット順にソートします。
  • AviUtlフォルダ内の配置は、プラグインの場合、README等に記載の開発者の指定に従います。スクリプトの場合、scriptフォルダ内で作者ごとにフォルダを分けて配置します。
  • downloadURLsとして、GitHubのReleasesを指定する場合、releases/latestの最新バージョンを表示するように指定します。
  • パッケージ数が多い開発者のパッケージは、リストを切り分けます。
  • integrityのtargetとするファイルは、編集しないファイルを指定します。設定ファイルなどの編集を前提としたファイルは指定しません。

リント

リントにESLintを使用しており、Google JavaScript Style Guideをベースに設定しています。内容は以下の通りです。

  • ECMAScript 2020を使用できます。
  • 変数の宣言には、基本的にconst / letを使用します。
  • モジュールに関してには、import / exportを使用します。

フォーマット

フォーマッターとして、Prettierを使用しており、コミット時に自動実行されます。

適用される設定は、.editorconfigに書かれた内容です。

Visual Studio Codeを利用している方へ

以上の機能をエディタ上で使うために、以下の拡張機能をインストールすることをおすすめします。