mirror of
https://github.com/Snigdha-OS/Snigdha-OS.github.io.git
synced 2025-09-05 20:26:43 +02:00
0baeb57cdd
Some checks failed
Check Conventional Commit / check-commit-message (push) Has been cancelled
112 lines
4.5 KiB
Markdown
112 lines
4.5 KiB
Markdown
# Contributing to Snigdha OS Web 🌐
|
||
|
||
Thank you for your interest in contributing to the **Snigdha OS Web** project! We’re excited to have you help us enhance the web presence of Snigdha OS. Whether you're fixing bugs, adding features, or improving documentation, your contributions are highly appreciated!
|
||
|
||
## 🛠 How to Contribute
|
||
|
||
### 1. **Fork the Repository** 🍴
|
||
|
||
To begin, fork the Snigdha OS Web repository to your GitHub account. This creates your personal copy of the project, where you can freely make changes without affecting the original repository.
|
||
|
||
- Navigate to the [Snigdha OS Web repository](https://github.com/Snigdha-OS/Snigdha-OS.github.io).
|
||
- Click the "Fork" button at the top right corner of the page.
|
||
|
||
### 2. **Clone Your Fork** 🚀
|
||
|
||
Next, clone the forked repository to your local machine:
|
||
|
||
```bash
|
||
git clone https://github.com/your-username/Snigdha-OS.github.io.git
|
||
```
|
||
|
||
### 3. **Create a New Branch** 🧑💻
|
||
|
||
Before you start making changes, create a new branch to keep your work organized and separate from the main codebase.
|
||
|
||
```bash
|
||
git checkout -b feature/your-branch-name
|
||
```
|
||
|
||
### 4. **Make Your Changes** ✏️
|
||
|
||
Now you’re ready to make changes! Whether you're fixing bugs, adding a new feature, or improving documentation, follow these guidelines:
|
||
|
||
- **For Code**: Ensure your code follows the project's coding standards and is well-commented.
|
||
- **For Documentation**: Use the correct formatting and provide clear, concise explanations.
|
||
- **For Styles/Design**: Make sure any design improvements align with the project's visual identity.
|
||
|
||
### 5. **Commit Your Changes** 💾
|
||
|
||
Commit your changes with a clear, descriptive message that explains what you've done.
|
||
|
||
```bash
|
||
git add .
|
||
git commit -m "Add/modify [brief description of changes]"
|
||
```
|
||
|
||
### 6. **Push Your Changes** 🔼
|
||
|
||
Push your new branch with your changes to your forked repository:
|
||
|
||
```bash
|
||
git push origin feature/your-branch-name
|
||
```
|
||
|
||
### 7. **Open a Pull Request (PR)** 🔄
|
||
|
||
Once you’ve made your changes and pushed them to your fork, open a pull request (PR) to merge them back into the original repository.
|
||
|
||
- Go to your fork on GitHub and click the “New Pull Request” button.
|
||
- Choose your branch and compare it with the base branch (usually `master` or `develop`).
|
||
- Write a detailed description of your changes and the issue they address (if any).
|
||
|
||
### 8. **Address Feedback** 💬
|
||
|
||
After opening the PR, the maintainers will review your changes and may provide feedback. Be ready to make further updates based on their suggestions.
|
||
|
||
### 9. **Celebrate!** 🎉
|
||
|
||
Once your PR is merged, congratulations! You've contributed to Snigdha OS Web and made the web experience better for everyone.
|
||
|
||
Snigdha OS Web
|
||
|
||
## 📝 Code of Conduct
|
||
|
||
Please adhere to the [Snigdha OS Code of Conduct](https://github.com/Snigdha-OS/Snigdha-OS.github.io/blob/master/CODE_OF_CONDUCT.md) when contributing to this repository. We strive to maintain a welcoming and inclusive environment for all contributors.
|
||
|
||
Snigdha OS Web
|
||
|
||
## 🚨 Reporting Issues
|
||
|
||
If you encounter any issues or bugs, please follow the steps below to report them:
|
||
|
||
1. **Search for Existing Issues**: Check if the issue has already been reported before opening a new one.
|
||
2. **Open a New Issue**: If the issue hasn’t been reported, go to the [Issues section](https://github.com/Snigdha-OS/Snigdha-OS.github.io/issues) and create a new issue.
|
||
3. **Provide Detailed Information**: Include as much detail as possible:
|
||
- A clear description of the issue.
|
||
- Steps to reproduce the issue.
|
||
- Any relevant logs or screenshots that can help maintainers understand the problem.
|
||
|
||
Snigdha OS Web
|
||
|
||
## 💡 Ideas for Contribution
|
||
|
||
There are many ways you can contribute to the Snigdha OS Web project:
|
||
|
||
- **Bug Fixes**: Help us identify and resolve bugs in the web app.
|
||
- **New Features**: Got an idea for a new feature? Feel free to open an issue or submit a PR!
|
||
- **Documentation Improvements**: Enhance the documentation by clarifying instructions, adding examples, or updating outdated content.
|
||
- **UI/UX Improvements**: Contribute to making the website visually appealing and easy to use by improving its design.
|
||
|
||
Snigdha OS Web
|
||
|
||
## 📜 License
|
||
|
||
By contributing to this repository, you agree that your contributions will be licensed under the [MIT License](https://github.com/Snigdha-OS/Snigdha-OS.github.io/blob/master/LICENSE).
|
||
|
||
Snigdha OS Web
|
||
|
||
## 🤝 Thank You!
|
||
|
||
Thank you for being a part of the Snigdha OS Web community! Every contribution, no matter how big or small, helps make Snigdha OS better for everyone. We look forward to your contributions!
|