コントリビュート

規模の大小に関わらず、コントリビュートはいつでも歓迎です。コントリビュートをしてくださる前に、行動規範をご一読ください。

コントリビュートの流れを知る

助けが必要な issue は help wanted タグでラベル付けしています。また、以下のようなタグでもカテゴリ分けを行っています。

  • cat-bug
  • cat-feature
  • cat-chore
  • cat-performance

以上が、あなたが作業できる主なカテゴリになります。 さらに、high-priority タグや good first issue タグを使って、それぞれプロジェクトにとって重要であるとか、主観的にみて最初に取り組みやすい issue だということを示しています。 triaged タグが付いていない場合や、needs-confirmationneeds-repro-scriptneeds-discussion タグが付いている場合、このような issue に最初から取り組むのは、おそらく賢明な選択ではないでしょう。

いくつか、最初に取り組むのに適したリンクを簡単に紹介しておきます。

ビルド

yarn run build
yarn run watch

ローカルビルドの yarn を使用する

alias yarn="node /path/to/yarn/lib/cli/index.js"

テスト

yarn run test
yarn run lint

プルリクエスト

我々は積極的にプルリクエストを歓迎します。

  1. リポジトリをフォークし、 master からあなたのブランチを作成してください。
  2. テストが必要なコードを追加した場合は、テストも追加してください。
  3. APIを変更した場合は、ドキュメントを更新してください。
  4. テストスイートがパスすることを確認してください。
  5. コードの構文チェックを行ってください

ライセンス

Yarn にコントリビュートすることで、あなたのコントリビュートが BSD license の下でライセンスされることに同意したことになります。