貢献
ご貢献いただきありがとうございます。
ご協力いただくには、次のことができます。
- 未解決のissueまたはpull requestに参加する
- 当ガイドを使用してルールを作成、拡張、デバッグする
- ドキュメントを改善する
- 新しいテストをあらゆるものに追加する
- ルールのパフォーマンスを改善する
- Stylelintをより良くするためのアイデアに関する新しいissueを開く
Stylelintの発展に貢献できるだけでなく、CSS、PostCSS、Node.js、ユニットテスト、オープンソースソフトウェアなどについて、一、二の知識を得ることもできるでしょう。私たちは貢献を奨励したいと考えています!もし参加したいのにできない場合は、改善できる点についてフィードバックをお寄せください。
コードの貢献
コーディングを開始するには、以下が必要です。
次に
- Stylelintリポジトリをフォークしてクローンする。
npm install
で全ての依存関係をインストールする。
テストを実行する
次に、npm test
を使用してテストを実行します。
ただし、これは25,000以上のユニットテストとlintingも実行します。
インタラクティブテストプロンプトを使用して、選択したファイルセットのみのテストを実行できます(これは開発中に実行したいでしょう)。たとえば、unit-allowed-list
とunit-disallowed-list
ルールのみのテストを実行するには
npm run watch
を実行して、インタラクティブテストプロンプトを開始します。p
を押して、ファイル名正規表現パターンでフィルタリングします。unit-allowed-list|unit-disallowed-list
、つまり各ルール名をパイプ記号(|
)で区切って入力します。
テストの詳細については、JestのWebサイトをご覧ください。
コードを書く
インタラクティブテストプロンプトが実行されている状態で、期待どおりに動作することを確認しながらコードを記述できます。
次のコードを記述できます
コードをフォーマットする
コードを自動的にフォーマットするために、Prettier(Huskyとlint-stagedのprecommit付き)を使用しています。
または、次のことができます。
npm run format
を使用してすべてのファイルのプリティ印刷をトリガーする- Prettierエディター統合を使用する
プルリクエストを開く
共有するものができたら、プルリクエストを開く時です。
あなたのプルリクエストをレビューしてマージした後、Stylelint組織のメンテナーになるよう招待します。その後、issue、プルリクエスト、リリースを管理できるようになります。また、フォークではなく、Stylelintリポジトリで作業できるようになります。
財政的な貢献
Open Collectiveでは、完全に透明性のある財政的な貢献を歓迎します。
誰でも費用を提出できます。コミュニティの発展に役立つと判断した場合、その費用を台帳に「マージ」します。Open Collectiveは、その費用を提出した人に払い戻します。
次のいずれかになることで、財政的に私たちをサポートできます