コントリビューター規約
コードを書く前に、ルールをお読みください。Babelize Elements における協働の方法です。
Before you code, read the rules.
Eight rules for contributing to Babelize Elements. Also available as a PDF.
01 · コードを書く前に相談する
バグを見つけましたか？ アイデアがありますか？ 機能を作りたいですか？ まだコーディングは始めないでください。
既存の Issue を確認してください。
作業の重複を避けます。
コントリビューションを調整された状態に保ちます。
02 · PR を作成する
1つの PR に、1つの明確な変更を。PR は次の状態を保ってください:
集中している
1つの問題を解決します。変更範囲は1つの Issue または機能に絞ってください。
明確である
何がなぜ変わったのかを説明してください。必要に応じて背景情報やスクリーンショットを追加し、Issue をリンクしてください。
テスト済みである
コードが期待どおりに動作し、既存の機能を壊さないことを確認してください。
レビューしやすい
小さく、きれいな状態に保ってください。フォーマットの変更や無関係なリファクタリングは含めないでください。
小さく焦点を絞った PR は、レビューしやすくなります。
履歴をすっきり保ち、より早くマージされます。
03 · コードの品質
保守しやすいコードを書いてください。PR を作成する前に:
既存のパターンに従う
プロジェクトとの一貫性を保ちます。
コンポーネントを再利用可能に保つ
柔軟で組み合わせ可能なパーツを作成します。
命名を統一する
命名規則に従ってください。
余分な依存関係を避ける
プロジェクトを軽量に保ちます。
エッジケースを処理する
エラー状態やさまざまなシナリオを考慮してください。
未使用のコードを削除する
コードベースをクリーンかつ最小限に保ちます。
変更をテストする
すべてが動作することを確認してください。
必要に応じてドキュメントを更新する
変更内容を他の人が理解できるようにしてください。
新しいコンポーネントですか？ コンポーネントテンプレートから始めてください。
読みやすさ > 賢さ。
コードは機械だけでなく、人のために書いてください。
04 · PR レビュー
PR を出したら終わりではありません。
レビュアーから次のような依頼があることがあります:
コードの変更
実装を改善するか、問題を修正します。
テストの追加
テストカバレッジを追加または改善します。
ドキュメントの更新
ドキュメント、コメント、README を更新します。
説明の補足
より詳しい背景や説明を提供します。
別のアプローチ
代替案について話し合います。
フィードバックもコントリビューションの一部です。
オープンな姿勢で臨み、迅速に応答し、建設的なやり取りを心がけてください。
05 · コミュニティガイドライン
コードだけでなく、人とともに作ってください。
敬意を持つ
コントリビューターとメンテナーに敬意をもって接してください。
建設的であること
問題を指摘し、解決策を一緒に見つけてください。
背景を伝える
判断の理由を説明してください。
他の人を助ける
知っていることを共有してください。
焦点を絞る
議論は関連する内容に留めてください。
あわせて 行動規範 もご覧ください。
良いコードは大切です。
良い協働も同じくらい大切です。
06 · スターとフォーク
プロジェクトを応援してください。
リポジトリにスターを付ける
スターはあなたの応援の証となり、より多くの開発者が Babelize Elements を見つけるきっかけになります。
リポジトリをフォークする
自分のコピーで試したり、変更を加えたり、PR を作成したりできます。
git clone https://github.com/<your-username>/babelize-elements.git
cd babelize-elements小さな行動が、大きな効果を生みます。
より包摂的なインターネットを、ともに作っていきましょう。
07 · コミュニティに参加する
1人で作る必要はありません。Babelize Discord に参加して、次の目的で #elements チャンネルへ行ってください:
質問
他の人に質問して助けを得ます。
アイデア
アイデアや提案を共有します。
コントリビューション
Issue を引き受けて、コントリビュートします。
フィードバック
私たちの成長を手伝ってください。
Issue
バグを報告し、修正について話し合います。
ヘルプを得る
行き詰まったら、コミュニティに聞いてください。
コントリビューションは対話から始まります。
アイデアは一緒に育てる方が速く成長します。
08 · コントリビュートを始める
作る準備はできましたか？
good first issue を探してください。オープンソース。より多くの人へ。
よりグローバルな未来を。私たちと一緒に作りましょう。