Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add Pull Request Template #307

Open
3 tasks done
officeneerajsaini opened this issue May 18, 2024 · 3 comments
Open
3 tasks done

DOC: Add Pull Request Template #307

officeneerajsaini opened this issue May 18, 2024 · 3 comments

Comments

@officeneerajsaini
Copy link

What's wrong with the existing documentation

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:

  • Contributors provide a clear and concise description of the changes made.
  • The template helps outline what areas of the code were modified and why.
  • Reviewers can quickly understand the context of the changes.
  • The review process becomes more efficient and less time-consuming.

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:

  • A summary of the changes made.
  • The reasons for the changes.
  • Any relevant issue numbers or references.
  • Instructions for testing the changes.
  • Any additional notes or context that might help the reviewers.

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.

Add ScreenShots

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

Record

  • I agree to follow this project's Code of Conduct
  • I'm a GSSOC'24 contributor
  • I want to work on this issue
Copy link

Congratulations, @officeneerajsaini! 🎉 Thank you for creating your issue. Your contribution is greatly appreciated and we look forward to working with you to resolve the issue. Keep up the great work!

We will promptly review your changes and offer feedback. Keep up the excellent work! Kindly remember to check our contributing guidelines

@Akshitha28112004
Copy link

Hey, I already have the template ready. So can you please assign me this issue under gssoc'24?

@officeneerajsaini
Copy link
Author

@Its-Aman-Yadav assign this issue to me .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants