dhruvpatidar359 / nextdraw

A WhiteBoard application used for prototyping supports Websockets
https://nextdraw.vercel.app
MIT License
45 stars 29 forks source link

Docs: Add Pull Request Template #57

Closed officeneerajsaini closed 6 months ago

officeneerajsaini commented 6 months ago

Describe the issue

Without a proper pull request (PR) template, contributors sometimes submit PRs without providing adequate descriptions of the changes they have made. This lack of information makes it challenging for reviewers to understand the purpose and scope of the changes, verify them effectively, and ensure that the code meets the project's standards. Consequently, reviewers often need to spend extra time reviewing the entire codebase, which is inefficient and time-consuming.

Steps To Reproduce

  1. A contributor raises a PR without using a PR template.
  2. The PR lacks a clear description of the changes made.
  3. Reviewers have to manually inspect all the code changes to understand their purpose.
  4. The review process becomes lengthy and cumbersome.

Expected Behavior

When a PR template is used:

Screenshots

Screenshot from 2024-05-18 17-42-22

Device Information [optional]

Additional Information

Implementing a PR template can significantly improve the efficiency of the code review process. A well-defined template should prompt contributors to provide:

By using a PR template, we can ensure that all necessary information is provided upfront, allowing reviewers to focus on the quality and correctness of the code rather than spending excessive time deciphering what changes have been made and why. This will not only save time for reviewers but also improve the overall quality of the codebase.

github-actions[bot] commented 6 months ago

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.