Skip to content

Oxc への貢献

Oxc への貢献にご関心をお寄せいただきありがとうございます! 私たちは次世代の JavaScript ツールチェーンを構築しており、ぜひ皆さんの協力をいただければと思います。

クイックスタート

最も速く始められる方法は、私たちの 良い最初の問題 をチェックすることです。これらは新規参加者に最適な慎重に選ばれたタスクです。

ガイドが必要ですか? 当チームやコミュニティメンバーが喜んでサポートする Discord コミュニティ へご参加ください。

貢献の形

あらゆる形での貢献を歓迎し、感謝しています:

🐛 バグレポート

  • パーサーのエラーまたは不正確なリンター動作を報告する
  • パフォーマンス上の問題やレグレッションを共有する
  • 検討されていないエッジケースをドキュメント化する

🚀 機能開発

  • 新しいリンティングルールを追加する
  • パーサーの適合性を向上させる
  • 変換機能を強化する
  • Oxc エコシステム内に新しいツールを構築する

📚 ドキュメント作成

  • セットアップガイドの改善
  • 例やチュートリアルの追加
  • アーキテクチャ決定事項のドキュメント化
  • 他の言語へのコンテンツ翻訳

🧪 テスト

  • 実際のコードベースからテストケースを追加する
  • テストカバレッジを向上させる
  • パフォーマンスベンチマークを作成する
  • エコシステムプロジェクトとの互換性テストを行う

🔧 インフラ整備

  • ビルドおよび CI システムの改善
  • 開発用ツールの強化
  • パフォーマンスが重要なパスの最適化
  • 他のツールとの互換性の維持

コードベースの理解

Oxc は複数のクラストラクトで構成されています:

  • oxc_parser: 高性能な JavaScript/TypeScript パーサー
  • oxc_linter: 650 以上のルールを持つ高速なリンティングエンジン
  • oxc_transformer: TypeScript および JSX 変換処理
  • oxc_minifier: JavaScript のミニファイ(開発中)
  • oxc_formatter: Prettier と互換性のあるコードフォーマット(アルファ版)

初めての貢献

  1. 問題を探すgood first issue とラベル付けされた問題を検索する
  2. 質問する:ディスコードや GitHub で明確さを求めるのは躊躇しないでください
  3. 小さなことから始める:ドキュメントの改善や小規模なバグ修正から始めましょう
  4. パターンを学ぶ:既存のコードを研究し、私たちのコーディング規約を理解する

コミュニティ

連絡手段

  • GitHub Discussions:設計に関する議論や質問に使用
  • Discord:チームおよびコミュニティメンバーとのリアルタイムチャット
  • GitHub Issues:バグレポートや機能要望に使用
  • Twitter:最新情報は @boshen_c をフォローしてください

行動規範

すべての人にとってウェルカムで包括的な体験を提供することに尽力しています。参加前に、行動規範 をお読みください。

AI 使用ポリシー

Oxc への貢献において、AI ツール(ChatGPT、Claude、Copilot など LLM 含む)を使用する場合:

  • 必ず AI の使用を明示する:メンテナーの負担を減らすため
  • すべての AI 生成の問題やプルリクエストに対して責任を持つ
  • 品質が低いかレビューされていない AI 内容は直ちに閉じられる

開発を支援するために AI ツールの使用を推奨していますが、すべての貢献は提出前に貢献者が徹底的にレビュー・テストする必要があります。AI 生成コードは、Oxc の基準を満たすよう理解・検証・変更されるべきです。

次のステップ

貢献を開始したいですか? 以下の場所から始めると良いでしょう:

あなたが私たちと共にどんなものを創り出すか、楽しみにしています! 🚀