Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
1754riya authored Jun 15, 2024
1 parent 16126c1 commit 474d7fe
Showing 1 changed file with 69 additions and 1 deletion.
70 changes: 69 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,74 @@ We appreciate your interest in contributing. 💐 This guide will help you get s

![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif)

## 📈 Development Workflow

When working on the project, please follow these guidelines:

Always work on a new branch for each separate issue or feature.
Keep your branch up to date with the main repository's master branch.
Write clear and descriptive commit messages.
Test your changes thoroughly before submitting a pull request.
Keep discussions polite and respectful.
## 🚩 Issue Report Process
Go to the project's issues.
Select the template that better fits your issue.
Give proper description for the issues.
Don't spam to get the assignment of the issue.
Wait for till someone is looking into it !.
Start working on issue only after you got assigned that issue.
## Need Help regarding some basics? 🤔
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
Forking a Repo
Cloning a Repo
How to create a Pull Request
Getting started with Git and GitHub
Learn GitHub from Scratch
## Pull Request Process 🚀
Ensure that you have self reviewed your code.
Make sure you have added the proper description for the functionality of the code.
I have commented my code, particularly in hard-to-understand areas.
Add screenshot it help in review.
Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.
## 🤝 Community Guidelines
We expect all contributors to adhere to the following community guidelines:
Be respectful and considerate towards others.
Use inclusive language and promote a welcoming environment.
Avoid personal attacks, harassment, or discrimination.
Keep discussions on-topic and constructive.
Help others and contribute positively to the community.
## Documentation 📑
Document any significant changes or additions to the codebase.
Provide clear and concise explanations of the functionality, usage, and any relevant considerations.
## ✅ Code Reviews
Be open to feedback and constructive criticism from other contributors.
Participate in code reviews by reviewing and providing feedback.
## 🚀🚀Feature Requests
Suggest new features or improvements that you believe would enhance the project.
## ☘️ Spread the Word
Share your experience and the project with others.
Spread the word about the project on social media, developer forums, or any relevant community platforms.
Thank you for your valuable contribution and for being a part of the Clueless Community! Together, we can make a difference. 🚀
## Happy Contributing 🔥
## ⚡ Important Guidelines
1. The contributors will be allowed to work on the issue ONLY after it has been assigned to them.
Expand All @@ -114,4 +182,4 @@ Thank you for your contribution!!
## Tip from us 😇
It always takes time to understand and learn. So, don't worry at all. We know **you have got this**! 💪

Show some ❤️ by 🌟 this repository!
Show some ❤️ by 🌟 this repository!

0 comments on commit 474d7fe

Please sign in to comment.