メインコンテンツにスキップ

貢献

ご貢献いただきありがとうございます。

ご協力いただくには、次のことができます。

Stylelintの発展に貢献できるだけでなく、CSS、PostCSS、Node.js、ユニットテスト、オープンソースソフトウェアなどについて、一、二の知識を得ることもできるでしょう。私たちは貢献を奨励したいと考えています!もし参加したいのにできない場合は、改善できる点についてフィードバックをお寄せください

コードの貢献

コーディングを開始するには、以下が必要です。

次に

  1. Stylelintリポジトリをフォークしてクローンする
  2. npm installで全ての依存関係をインストールする。

テストを実行する

次に、npm testを使用してテストを実行します。

ただし、これは25,000以上のユニットテストとlintingも実行します。

インタラクティブテストプロンプトを使用して、選択したファイルセットのみのテストを実行できます(これは開発中に実行したいでしょう)。たとえば、unit-allowed-listunit-disallowed-listルールのみのテストを実行するには

  1. npm run watchを実行して、インタラクティブテストプロンプトを開始します。
  2. pを押して、ファイル名正規表現パターンでフィルタリングします。
  3. unit-allowed-list|unit-disallowed-list、つまり各ルール名をパイプ記号(|)で区切って入力します。

テストの詳細については、JestのWebサイトをご覧ください。

コードを書く

インタラクティブテストプロンプトが実行されている状態で、期待どおりに動作することを確認しながらコードを記述できます。

次のコードを記述できます

コードをフォーマットする

コードを自動的にフォーマットするために、PrettierHuskyとlint-stagedのprecommit付き)を使用しています。

または、次のことができます。

プルリクエストを開く

共有するものができたら、プルリクエストを開く時です。

あなたのプルリクエストをレビューしてマージした後、Stylelint組織のメンテナーになるよう招待します。その後、issue、プルリクエスト、リリースを管理できるようになります。また、フォークではなく、Stylelintリポジトリで作業できるようになります。

財政的な貢献

Open Collectiveでは、完全に透明性のある財政的な貢献を歓迎します。

誰でも費用を提出できます。コミュニティの発展に役立つと判断した場合、その費用を台帳に「マージ」します。Open Collectiveは、その費用を提出した人に払い戻します。

次のいずれかになることで、財政的に私たちをサポートできます