Skip to content
Carch Wiki

Contributing

📑 Table of Contents

Section titled “📑 Table of Contents”

Contributing to Carch

Section titled “Contributing to Carch”

We’re excited that you’re interested in contributing to Carch! Contributions of all kinds are welcome, whether you’re fixing bugs, adding new features, or improving documentation. Follow this guide to get started.

📌 Understand the Codebase

Section titled “📌 Understand the Codebase”

If you have questions or need help, feel free to contact us:
📧 Email: [email protected]
💬 Discord: Join Here

Steps to Contribute

Section titled “Steps to Contribute”

1. 🍽️ Fork the Repository

Section titled “1. 🍽️ Fork the Repository”
  • Go to the Carch GitHub page.
  • Click the Fork button in the top-right corner to create your own copy of the repository.

2. 🌿 Clone the Forked Repository

Section titled “2. 🌿 Clone the Forked Repository”

  • Use the following command to clone the repository to your local system:

    Terminal window
    git clone https://github.com/your-username/carch.git

  • Replace your-username with your GitHub username.

3. 🌱 Set the Original Repository as Upstream

Section titled “3. 🌱 Set the Original Repository as Upstream”

  • Add the original Carch repository as an upstream remote to keep your fork up to date:

    Terminal window
    cd carch
    Terminal window
    git remote add upstream https://github.com/original-author/carch.git

4. 🍇 Create a New Feature Branch

Section titled “4. 🍇 Create a New Feature Branch”

  • Before making changes, create a new branch with a descriptive name:

    Terminal window
    git checkout -b feature/your-branch-name

  • Examples of branch names:

    • feature/add-new-script
    • bugfix/fix-installation-issue

5. 🔧 Make Your Changes

Section titled “5. 🔧 Make Your Changes”
  • Implement the necessary changes to the code or documentation.
  • Ensure that your changes are clear, tested, and follow the project’s coding standards.

6. 📝 Stage and Commit Your Changes

Section titled “6. 📝 Stage and Commit Your Changes”

  • Add the modified files to the staging area:

    Terminal window
    git add .

  • Commit your changes with a clear message:

    Terminal window
    git commit -m "Add: [brief description of your changes]"

7. 🚀 Push the Changes to Your Fork

Section titled “7. 🚀 Push the Changes to Your Fork”

  • Push your branch to your forked repository:

    Terminal window
    git push origin feature/your-branch-name

8. 📥 Submit a Pull Request (PR)

Section titled “8. 📥 Submit a Pull Request (PR)”
  • Go to the original Carch repository on GitHub.
  • Click on New Pull Request.
  • Select your branch from the dropdown and describe your changes in detail.
  • Submit the PR for review!

📚 Contributing to Carch Docs

Section titled “📚 Contributing to Carch Docs”

Carch Docs is ➥ Live Here

Section titled “Carch Docs is ➥ Live Here”

🚀 Ways to Contribute

Section titled “🚀 Ways to Contribute”

You can contribute by:

  • 🪛 Fixing typos or mistakes in existing guides
  • 🌐 Translating the documentation into other languages (highly encouraged!)

🌍 Translating Documentation

Section titled “🌍 Translating Documentation”

Want to help make Carch accessible to users worldwide? Help us translate the docs!

Section titled “Want to help make Carch accessible to users worldwide? Help us translate the docs!”

If you’re contributing a new language, follow these steps:

  1. 📁 Create a new folder for your language inside the docs/ directory. Use ISO 639-1 codes (e.g. fr, es, hi, etc.).
  2. 🛠️ Translate the Markdown content inside the new folder.
  3. 🧩 Modify docs/.vitepress/config.ts:
    • Add your language in the locales section.
    • Provide a label, lang, and link for navigation.

🧪 Testing Your Changes Locally

Section titled “🧪 Testing Your Changes Locally”

To preview your changes:

Terminal window
bun install
bun run docs:dev

🧾 Commit Style

Section titled “🧾 Commit Style”

Use clear commit messages like:

Terminal window
git commit -m "fix(docs): correct typo in installation guide"
git commit -m "feat(docs): add Hindi translation"

More on Conventional Commits.

🙌 Thanks for helping improve the documentation!

Section titled “🙌 Thanks for helping improve the documentation!”

Guidelines

Section titled “Guidelines”

Code Quality

Section titled “Code Quality”
  • Follow the existing coding style of the project.
  • Write clear, concise, and well-documented code.

Testing

Section titled “Testing”
  • Test your changes locally to ensure they work as expected.
  • If your changes introduce new features, add necessary tests where applicable.

Documentation

Section titled “Documentation”
  • If your changes involve new functionality, update the relevant documentation.
  • Ensure the README or Wiki reflects your updates.

Syncing Your Fork

Section titled “Syncing Your Fork”

  • Keep your fork updated to avoid conflicts:

    Terminal window
    git fetch upstream
    Terminal window
    git merge upstream/main
    • Replace main with the default branch of the repository if it’s different.

Thank you for contributing to Carch! Your effort helps make this project better for everyone.