📝 docs(contrib): add gudeline

2025-09-05 12:56:37 +02:00 · 2024-12-17 14:53:46 +05:30
parent d470498154
commit e4078d9dfd
1 changed files with 110 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -0,0 +1,110 @@
+# Contributing to Snigdha OS Web Dev 🌐
+
+Thank you for your interest in contributing to the Snigdha OS Web Dev project! We're excited to have you help us improve the web presence of Snigdha OS. Whether you're fixing a bug, adding a feature, or improving the documentation, your contributions are highly valued.
+
+## 🛠 How to Contribute
+
+### 1. **Fork the Repository** 🍴
+
+Start by forking the Snigdha OS Web Dev repository to your own GitHub account. This creates a personal copy of the project where you can make changes without affecting the original project.
+
+- Navigate to the [Snigdha OS Web Dev repository](https://github.com/Snigdha-OS/snigdhaos-web-dev).
+- Click on the "Fork" button at the top right of the page.
+
+### 2. **Clone Your Fork** 🚀
+
+Clone the forked repository to your local machine:
+
+```bash
+git clone https://github.com/your-username/snigdhaos-web-dev.git
+```
+
+### 3. **Create a New Branch** 🧑‍💻
+
+Once you have the repository cloned, create a new branch for your work. This helps keep your contributions organized.
+
+```bash
+git checkout -b feature/your-branch-name
+```
+
+### 4. **Make Your Changes** ✏️
+
+Now you can make changes! Whether you're fixing a bug, adding a feature, or improving documentation, make sure to follow the guidelines for code style and project structure.
+
+- **For Code**: Ensure that your code follows the project's coding standards and is well-documented.
+- **For Documentation**: Follow the formatting guidelines and be clear with your explanations.
+
+### 5. **Commit Your Changes** 💾
+
+Commit your changes with a clear and descriptive message.
+
+```bash
+git add .
+git commit -m "Add/modify [brief description of changes]"
+```
+
+### 6. **Push Your Changes** 🔼
+
+Push your branch to your forked repository:
+
+```bash
+git push origin feature/your-branch-name
+```
+
+### 7. **Open a Pull Request (PR)** 🔄
+
+Once your changes are ready, open a pull request to merge your work back into the original repository.
+
+- Go to your fork on GitHub and click the "New Pull Request" button.
+- Select your branch and the base branch (usually `master` or `develop`).
+- Provide a clear description of the changes in the PR, explaining the problem it solves or the feature it adds.
+
+### 8. **Address Feedback** 💬
+
+After opening the PR, maintainers may review your changes and provide feedback. Be prepared to make additional changes based on their suggestions.
+
+### 9. **Celebrate** 🎉
+
+Once your pull request is merged, celebrate! You've just contributed to Snigdha OS Web Dev and made the web experience better for everyone!
+
+
+
+## 📝 Code of Conduct
+
+Please follow the [Snigdha OS Code of Conduct](https://github.com/Snigdha-OS/snigdhaos-web-dev/blob/master/CODE_OF_CONDUCT.md) when contributing to this repository. We want to foster a welcoming and inclusive environment for all contributors.
+
+
+
+## 🚨 Reporting Issues
+
+If you find any issues or bugs, please follow the steps below to report them:
+
+1. Check if the issue has already been reported.
+2. If not, open an issue in the [Issues section](https://github.com/Snigdha-OS/snigdhaos-web-dev/issues).
+3. Provide as much detail as possible: 
+   - Describe the issue clearly.
+   - Include steps to reproduce the issue.
+   - If possible, attach logs or screenshots.
+
+
+
+## 💡 Ideas for Contribution
+
+You can contribute in various ways:
+
+- **Bug Fixes**: Help us by identifying and fixing issues in the web app.
+- **Feature Requests**: Have an idea for a new feature? Open an issue or a pull request!
+- **Documentation**: Contribute to improving the documentation by clarifying instructions or adding new information.
+- **Styling/Design**: Help us make the website look better by improving the UI and UX.
+
+
+
+## 📜 License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](https://github.com/Snigdha-OS/snigdhaos-web-dev/blob/master/LICENSE).
+
+
+
+## 🤝 Thank You!
+
+Thank you for being a part of the Snigdha OS Web Dev community! Every contribution helps us make Snigdha OS better for everyone. We look forward to your contributions!