snigdhaos-archiso/CONTRIBUTING.md

🤝 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 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 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:

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:

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:

git add .  
git commit -m "Add: Description of your changes"  

Step 6: Push Your Changes

Push your branch to your forked repository:

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:

   sudo pacman -S archiso  
   

Setting Up the Project

1. Clone the repository:

   git clone https://github.com/Snigdha-OS/snigdhaos-archiso.git  
   cd snigdhaos-archiso  
   

2. Build the ISO:

   ./scripts/build.sh  
   

3. Test the ISO in a virtual machine or live environment.

🔍 Code of Conduct

Please adhere to our Code of Conduct 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.
• 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! 🚀