From d75fc8bd97fe34c319e6480000ea142378cca812 Mon Sep 17 00:00:00 2001 From: Hari Chalise Date: Sun, 9 Feb 2025 21:22:32 +0545 Subject: [PATCH] update contributing guide --- docs/github/contributing.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/github/contributing.md b/docs/github/contributing.md index e28158f..86cdc7d 100644 --- a/docs/github/contributing.md +++ b/docs/github/contributing.md @@ -4,6 +4,28 @@ 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 + +> [!NOTE] +> Before contributing, **understand the structure** of Carch: +> - **The `main script` of Carch is located in:** +>```bash +> build/carch +> ``` +> +> - **All `additional` scripts of Carch are stored in:** +> ```sh +> scripts/*.sh +> ``` + + +> [!IMPORTANT] +> First, **analyze how the script works** before making any changes. If you want to improve or add to the project, make sure you **understand the structure** and how each piece interacts. This will help you contribute in a way that is consistent with the project’s design. + +If you have questions or need help, feel free to **contact us**: +📧 Email: harilvfs@chalisehari.com.np +💬 Discord: Join Here + ## Steps to Contribute ### 1. 🍽️ Fork the Repository