📑 目次
Carch への貢献
Carch への貢献に興味を持っていただき、ありがとうございます！バグ修正、新機能の追加、ドキュメントの改善など、あらゆる種類の貢献を歓迎します。このガイドに従って始めてください。
WARNING
貢献を行う前に、まず 機能リクエスト セクションでissueを開いてください。実装を進める前に、そこで変更について話し合います。
📌 コードベースを理解する
IMPORTANT
まず、変更を加える前にスクリプトの動作を分析してください。プロジェクトを改善または追加したい場合は、構造と各要素がどのように相互作用するかを理解していることを確認してください。これにより、プロジェクトの設計と一致する方法で貢献することができます。
コミットする際は、従来のコミットスタイルに従ってください：
feat: あなたのコミットメッセージ または fix: あなたのコミットメッセージところで、コミットする前に：
.shスクリプトファイルを変更する場合は、shfmtでフォーマットされていることを確認してくださいdesc.toml（スクリプトまたは説明）を更新する場合は、cargo xtask ogenを実行してdocs/overview.mdを更新してください- Rustファイルの任意の部分を変更する場合は、
cargo xtask ciを実行してフォーマットとその他の検証をチェックしてください
どこにもエラーがないことを確認せずに直接プッシュしないでください。
従来のコミットについての詳細は、このガイドを参照してください。
質問がある場合や助けが必要な場合は、お気軽にお問い合わせください： 📧 メール: harilvfs@chalisehari.com.np 💬 Discord: こちらから参加
貢献の手順
1. 🍽️ リポジトリをフォークする
- CarchのGitHubページにアクセスします。
- 右上隅のフォークボタンをクリックして、リポジトリの自分のコピーを作成します。
2. 🌿 フォークしたリポジトリをクローンする
以下のコマンドを使用して、リポジトリをローカルシステムにクローンします：
bashgit clone https://github.com/あなたのユーザー名/carch.gitあなたのユーザー名を自分のGitHubユーザー名に置き換えてください。
💡 ヒント
GitHub DesktopなどのGUIツールやGitHubのWebインターフェースを使用してリポジトリをフォークおよびクローンすることもできます。これらのツールは、貢献を管理するための使いやすいビジュアルインターフェースを提供します。
3. 🌱 元のリポジトリをアップストリームとして設定する
元のCarchリポジトリをアップストリームリモートとして追加し、フォークを最新の状態に保ちます：
bashcd carchbashgit remote add upstream https://github.com/原作者/carch.git
4. 🍇 新しい機能ブランチを作成する
変更を加える前に、説明的な名前の新しいブランチを作成します：
bashgit checkout -b feature/あなたのブランチ名ブランチ名の例：
feature/新しいスクリプト追加bugfix/インストール問題修正
5. 🔧 変更を加える
- コードまたはドキュメントに必要な変更を実装します。
- 変更が明確で、テスト済みであり、プロジェクトのコーディング標準に従っていることを確認してください。
6. 📝 変更をステージングしてコミットする
変更したファイルをステージングエリアに追加します：
bashgit add .明確なメッセージで変更をコミットします：
bashgit commit -m "追加: [変更内容の簡単な説明]"
7. 🚀 変更をフォークにプッシュする
ブランチをフォークしたリポジトリにプッシュします：
bashgit push origin feature/あなたのブランチ名
8. 📥 プルリクエスト（PR）を送信する
- GitHub上の元のCarchリポジトリにアクセスします。
- 新しいプルリクエストをクリックします。
- ドロップダウンからブランチを選択し、変更内容を詳細に説明します。
- レビューのためにPRを送信してください！
📚 Carchドキュメントへの貢献
Carchドキュメント ➥ こちら
🚀 貢献方法
以下の方法で貢献できます：
- 🪛 既存のガイドのタイプミスや誤りを修正する
- 🌐 ドキュメントを他の言語に翻訳する（大歓迎です！）
🌍 ドキュメントの翻訳
Carchを世界中のユーザーが利用できるようにしたいですか？ドキュメントの翻訳を手伝ってください！
新しい言語で貢献する場合は、次の手順に従ってください：
- 📁
docs/ディレクトリ内に新しい言語のフォルダを作成します。ISO 639-1コードを使用してください（例：fr、es、hiなど）。 - 🛠️ 新しいフォルダ内のMarkdownコンテンツを翻訳します。
- 🧩
docs/.vitepress/config.tsを修正します：localesセクションに言語を追加します。- ナビゲーション用に
label、lang、linkを提供します。
🧪 変更をローカルでテストする
変更をプレビューするには：
bun install
bun run docs:devIMPORTANT
主要な構造的または組織的な変更を計画している場合は、最初にissueを開いてください。事前に議論し、協力したいと思います！
🧾 コミットスタイル
以下のように明確なコミットメッセージを使用してください：
git commit -m "fix(docs): インストールガイドのタイプミスを修正"
git commit -m "feat(docs): ヒンディー語翻訳を追加"従来のコミットの詳細はこちら。
🙌 ドキュメントの改善にご協力いただきありがとうございます！
ガイドライン
コード品質
- プロジェクトの既存のコーディングスタイルに従ってください。
- 明確で簡潔、かつ十分に文書化されたコードを書いてください。
テスト
- 変更をローカルでテストし、期待通りに動作することを確認してください。
- 変更に新機能が含まれる場合は、該当する場合に必要なテストを追加してください。
ドキュメント
- 変更に新しい機能が含まれる場合は、関連するドキュメントを更新してください。
- READMEまたはWikiが更新内容を反映していることを確認してください。
フォークの同期
競合を避けるためにフォークを最新の状態に保ってください：
bashgit fetch upstreambashgit merge upstream/mainリポジトリのデフォルトブランチが異なる場合は、
mainをそのブランチに置き換えてください。
Carchへの貢献ありがとうございます！あなたの努力がこのプロジェクトをより良いものにします。 