Snigdha-OS/documentation
2
0
Fork 0
mirror of https://github.com/Snigdha-OS/documentation.git synced 2025-09-06 19:15:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

⏳ @eshanized updated the website 🎉 !!!

Browse Source
This commit is contained in:
Eshan Roy (Eshanized)
2024-04-26 12:31:52 +05:30
parent 8ee0d25f5b
commit da917c09d3
88 changed files with 304 additions and 1876 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/introduction/contributing.md
View File

@@ -2,7 +2,7 @@
sidebar_position: 7
---
# Code Contribution Guidelines
# Contribution Guidelines
Thank you for considering contributing to **Snigdha OS**! We welcome contributions from everyone.
@@ -29,46 +29,48 @@ There are several ways you can contribute to **Snigdha OS**:
- 👉 Create a new branch for your feature or bug fix. Read [how to create new branch on forked repository?](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)
- 👉 Make your changes and ensure they follow our coding standards.
- 👉 Make your changes and ensure they follow our [coding standards](/introduction/coding-standard).
e. Write tests to cover your changes if applicable.
- 👉 Write tests to cover your changes if applicable.
f. Run existing tests and ensure they pass with your changes.
- 👉 Run existing tests and ensure they pass with your changes.
g. Commit your changes with clear and descriptive commit messages.
- 👉 Commit your changes with clear and descriptive commit messages.
h. Push your changes to your forked repository.
- 👉 Push your changes to your forked repository.
i. Open a pull request against the `main` branch of our repository.
- 👉 Open a pull request against the `master` branch of our repository. Read [how to open a pull request on github](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
j. Provide a clear description of your changes in the pull request, including any relevant information for reviewers.
- 👉 Provide a clear description of your changes in the pull request, including any relevant information for reviewers.
4. **Documentation Contributions**: Improving documentation is also a valuable contribution. If you find errors or areas that need clarification, please submit a pull request with your proposed changes.
જ⁀➴ **Documentation Contributions**: Improving documentation is also a valuable contribution. If you find errors or areas that need clarification, please submit a pull request with your proposed changes.
## Code Standards
When contributing code, please adhere to the following standards:
- Follow the style guide for the programming language used in the project.
- Write clear, concise, and descriptive code comments.
- Ensure your code is well-tested, and add tests for any new functionality.
- Keep your commits atomic and focused on a single logical change.
- Use clear and descriptive commit messages following the [Conventional Commits](https://www.conventionalcommits.org/) format.
- If your change requires updating documentation, please include those updates in your pull request.
- 👉 Follow the style guide for the programming language used in the project.
- 👉 Write clear, concise, and descriptive code comments.
- 👉 Ensure your code is well-tested, and add tests for any new functionality.
- 👉 Keep your commits atomic and focused on a single logical change.
- 👉 Use clear and descriptive commit messages following the [Conventional Commits](https://www.conventionalcommits.org/) format.
- 👉 If your change requires updating documentation, please include those updates in your pull request.
## Code Review Process
All code contributions will go through a review process before being merged. Here's what to expect during the review process:
1. Your pull request will be assigned to one or more reviewers.
2. Reviewers will provide feedback and suggest changes if necessary.
3. You may need to address the feedback by making additional changes to your code.
4. Once all feedback has been addressed, and the code meets our standards, it will be merged into the main repository.
- 👉 Your pull request will be assigned to one or more reviewers.
- 👉 Reviewers will provide feedback and suggest changes if necessary.
- 👉 You may need to address the feedback by making additional changes to your code.
- 👉 Once all feedback has been addressed, and the code meets our standards, it will be merged into the main repository.
## Code of Conduct
Please note that by contributing to **Snigdha OS**, you are agreeing to abide by our Code of Conduct. Any violations of the code of conduct will not be tolerated and may result in your contributions being rejected or your participation in the project being revoked.
Please note that by contributing to **Snigdha OS**, you are agreeing to abide by our [Code of Conduct](/introduction/code_of_conduct). Any violations of the code of conduct will not be tolerated and may result in your contributions being rejected or your participation in the project being revoked.
## Need Help?
If you have any questions or need assistance with contributing, feel free to reach out to us via [email/issue tracker/discussion forum/etc.].
If you have any questions or need assistance with contributing, feel free to reach out to us via:
- [Email: hello@snigdhaos.org](mailto:hello@snigdhaos.org)
- [Forum](https://forum.snigdhaos.org)