From f36ec13dd2725a883ca0da0cf05b43abec861f09 Mon Sep 17 00:00:00 2001 From: eshanized Date: Tue, 31 Dec 2024 13:13:41 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20contribution=20guideline?= =?UTF-8?q?s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 111 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4d30286 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,111 @@ +# 🀝 Contributing to Snigdha OS ArchISO + +Thank you for considering contributing to **Snigdha OS ArchISO**! πŸŽ‰ Your help is invaluable in improving the project and making Snigdha OS better for everyone. Whether you're reporting bugs, suggesting new features, or submitting code, every contribution counts. + +## πŸ› οΈ How to Contribute + +### 1. πŸ› Reporting Bugs +Found a bug? Let us know! + +- **Search for existing issues**: Check if someone else has already reported the issue. +- **Create a new issue**: If the issue is new, [open an issue](https://github.com/Snigdha-OS/snigdhaos-archiso/issues) and include: + - A clear title and description. + - Steps to reproduce the issue. + - Any relevant logs or screenshots. + +### 2. πŸ’‘ Suggesting Features +Have an idea to improve Snigdha OS ArchISO? + +- **Search for existing feature requests**: Your idea might already be under discussion. +- **Create a new feature request**: [Open an issue](https://github.com/Snigdha-OS/snigdhaos-archiso/issues) and tag it as a feature request. Provide as much detail as possible, including: + - The problem your feature will solve. + - How the feature will work. + +### 3. πŸ§‘β€πŸ’» Submitting Code + +#### Step 1: Fork the Repository +Click the **Fork** button on the top-right of the repository page to create your own copy. + +#### Step 2: Clone Your Fork +Use the following command to clone your fork locally: +```bash +git clone https://github.com/your-username/snigdhaos-archiso.git +cd snigdhaos-archiso +``` + +#### Step 3: Create a Branch +Create a new branch for your changes: +```bash +git checkout -b feature/your-feature-name +``` + +#### Step 4: Make Changes +Edit the files you want to improve. Be sure to: +- Follow the repository's coding standards. +- Test your changes locally before committing them. + +#### Step 5: Commit Your Changes +Write clear and concise commit messages: +```bash +git add . +git commit -m "Add: Description of your changes" +``` + +#### Step 6: Push Your Changes +Push your branch to your forked repository: +```bash +git push origin feature/your-feature-name +``` + +#### Step 7: Create a Pull Request +Go to the original repository and click **Pull Requests**. Select **New Pull Request** and: +- Choose your branch as the source branch. +- Provide a detailed description of your changes. + +## πŸ’» Development Environment + +### Prerequisites +Ensure your system meets these requirements: +1. Arch Linux or an Arch-based distribution. +2. Install `archiso` for building the ISO: + ```bash + sudo pacman -S archiso + ``` + +### Setting Up the Project + +1. Clone the repository: + ```bash + git clone https://github.com/Snigdha-OS/snigdhaos-archiso.git + cd snigdhaos-archiso + ``` + +2. Build the ISO: + ```bash + ./scripts/build.sh + ``` + +3. Test the ISO in a virtual machine or live environment. + +## πŸ” Code of Conduct + +Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment. + +## 🌟 Tips for Contributing + +- Keep your contributions focused and well-documented. +- Write clean, maintainable, and modular code. +- Test your changes thoroughly. +- Review the repository’s current structure and adhere to its standards. + +## πŸ›‘οΈ License + +By contributing, you agree that your contributions will be licensed under the **MIT License** of this repository. + +## πŸ’¬ Questions? + +If you have any questions about contributing, feel free to: +- Open a [discussion](https://github.com/orgs/Snigdha-OS/discussions/new?category=q-a). +- Tag maintainers or contributors in issues for clarification. + +Let’s work together to make **Snigdha OS ArchISO** a reliable and feature-rich platform for the community! πŸš€