mirror of
https://github.com/Snigdha-OS/Snigdha-OS.github.io.git
synced 2025-09-05 20:26:43 +02:00
🐛 fix: dev to master
Some checks failed
Check Conventional Commit / check-commit-message (push) Has been cancelled
Some checks failed
Check Conventional Commit / check-commit-message (push) Has been cancelled
This commit is contained in:
@@ -1,27 +1,27 @@
|
||||
# Contributing to Snigdha OS Web Dev 🌐
|
||||
# Contributing to Snigdha OS Web 🌐
|
||||
|
||||
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.
|
||||
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** 🍴
|
||||
|
||||
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.
|
||||
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 Dev repository](https://github.com/Snigdha-OS/snigdhaos-web-dev).
|
||||
- Click on the "Fork" button at the top right of the page.
|
||||
- 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** 🚀
|
||||
|
||||
Clone the forked repository to your local machine:
|
||||
Next, clone the forked repository to your local machine:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-username/snigdhaos-web-dev.git
|
||||
git clone https://github.com/your-username/Snigdha-OS.github.io.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.
|
||||
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
|
||||
@@ -29,14 +29,15 @@ 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.
|
||||
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 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.
|
||||
- **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 and descriptive message.
|
||||
Commit your changes with a clear, descriptive message that explains what you've done.
|
||||
|
||||
```bash
|
||||
git add .
|
||||
@@ -45,7 +46,7 @@ git commit -m "Add/modify [brief description of changes]"
|
||||
|
||||
### 6. **Push Your Changes** 🔼
|
||||
|
||||
Push your branch to your forked repository:
|
||||
Push your new branch with your changes to your forked repository:
|
||||
|
||||
```bash
|
||||
git push origin feature/your-branch-name
|
||||
@@ -53,58 +54,58 @@ 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.
|
||||
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.
|
||||
- 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.
|
||||
- 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, maintainers may review your changes and provide feedback. Be prepared to make additional changes based on their suggestions.
|
||||
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 pull request is merged, celebrate! You've just contributed to Snigdha OS Web Dev and made the web experience better for everyone!
|
||||
### 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 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.
|
||||
|
||||
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 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.
|
||||
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
|
||||
|
||||
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.
|
||||
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, you agree that your contributions will be licensed under the [MIT License](https://github.com/Snigdha-OS/snigdhaos-web-dev/blob/master/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 Dev community! Every contribution helps us make Snigdha OS better for everyone. We look forward to your contributions!
|
||||
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!
|
||||
|
Reference in New Issue
Block a user