コントリビュート

ご興味をもっていただきありがとうございます。

以下の事項でご貢献いただけます。

• 問題やバグを報告する
• W3C/WHATWGの仕様変更に伴うスキーマの更新
• 新機能の要望・提案
• APIやCLIの改善
• 仕様に沿ったリント設計の見直し
• ドキュメントやウェブサイトの改善
• 運用方法の再設計と改善
• テストやカバレッジの改善
• プラグインの開発

目的は、すべての開発者により良いマークアップができることと、多様なプロジェクトそれぞれに適合することです。そのため、みなさんの協力が必要です。あなたの思いが、多様性につながります。

コードへの貢献

以下が必要です。

• Node.js v18以降
• Yarn

リポジトリをクローンした後、Dockerからのインストールも可能です。

コードを書いた際は、次のことをお願いしています。

• yarn lintでコードの整形とリントチェックをしてください
• yarn buildでビルドが正常に行われることを確認してください
• yarn testでテストが成功することを確認してください
• トピックブランチにプッシュし、プルリクエストを作成してください
• 以下のレビュアーをアサインします。
  • コード全般、コードの改善の場合: @yusukehirao
  • プラグイン開発の場合: @yusukehirao
  • ドキュメントおよびウェブサイト関連の場合: @yusukehirao, @kagankan
  • dockerfileに関すること: @conao3
  • GitHub Actionsに関すること: @tyankatsu0105