Brijeshthummar02 commented 1 month ago

Description

The current CONTRIBUTING.md file is brief and lacks detailed information that can help potential contributors understand how to effectively contribute to the project. An update is needed to make it more engaging and informative.

Screenshots

No response

Additional Information

Proposed Changes:

Add More Detailed Guidelines: • Include sections on the types of contributions (features, bug fixes, documentation, etc.). • Provide a clear workflow from forking the repository to submitting a pull request.
Create a Table of Contents: • Organize the document with a Table of Contents for easier navigation.
Provide Examples: • Include examples of commit messages, pull requests, and branching strategies.
Add Links to Resources: • Link to additional resources, such as coding standards, issue templates, and relevant documentation.
Include a Code of Conduct: • Reinforce the importance of a welcoming community by including a Code of Conduct section.
Visual Enhancements: • Use formatting tools (like headings, lists, and code blocks) to improve readability and engagement.

Benefits:

• Makes the contribution process clearer for new contributors. • Encourages more people to participate in the project by providing a welcoming and informative guide. • Increases overall project quality by ensuring contributions meet defined standards.

Labels:

• documentation • good first issue • low priority

Ready to Work?

[x] I want to work on this enhancement

tri0n0 commented 1 month ago

Hi there, i have done some of the work on this, you can check it out on the pull request section for this. And if any problem arises let me know.

Brijeshthummar02 commented 1 month ago

@tri0n0 can you mention specific pr no. related to the issue.