search

DhanushNehru / board

A black board to just write contents and display
https://board-dhanushnehru.netlify.app/
MIT License
9 stars 33 forks source link

Update CONTRIBUTING.md with Guidelines on Creating Issues, Writing Better Comments, and Submitting PRs #74

Open mahendra3399 opened 3 days ago

mahendra3399 commented 3 days ago

Will Update the CONTRIBUTING.md file to provide clear instructions on how contributors can effectively participate in the project. The updated document should include the following details:

  1. How to Create Issues: Explaining the process of creating an issue, including how to properly describe the problem or feature request. Mention the importance of providing a clear, concise title and a detailed explanation of the issue. Encourage the use of templates if available and emphasize attaching any relevant screenshots, logs, or code snippets.

  2. Writing Better Comments for Issue Assignment: Will Provide guidelines on how contributors should communicate when asking for issues to be assigned. Mention the need for detailing how they plan to approach and solve the issue. Request contributors to include thoughtful and constructive comments to make it easier for maintainers to understand their approach.

  3. How to Create Pull Requests (PRs): Step-by-step instructions on how to submit a pull request, from forking the repo to making changes and submitting the PR. Explaining the importance of maintaining a clean and organized commit history (squash or rebase commits if necessary). Highlighting the need for clear commit messages that explain the changes made, and link the issue being resolved in the PR description.

  4. Time Limit for Assigned Issues: Specifying that once an issue is assigned, contributors will have 1-2 days to solve the issue and submit a PR. Mentioning that failure to meet the deadline may result in the issue being reassigned to someone else.

These updates will help streamline the contribution process and ensure that all contributors are aligned on the best practices for creating issues, providing meaningful comments, and submitting clean pull requests.

Kindly assign me this issue under Hacktoberfest 2024, Thank you!!

mahendra3399 commented 2 days ago

Thank you will start it

mahendra3399 commented 2 days ago

@DhanushNehru, can you review the PR