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

Update PULL_REQUEST_TEMPLATE.md #37

Closed
wants to merge 2 commits into from
Closed

Conversation

Burhan-Q
Copy link
Member

@Burhan-Q Burhan-Q commented Jan 6, 2024

Draft idea for a new PR template per conversation on Slack. @glenn-jocher please let me know if there are any changes you'd like to make or if you prefer to keep with the current iteration. Curious for input from @AyushExel @kalenmike @Laughing-q and @RizwanMunawar as well.

Rendered Preview

image

Additions

  • Adds commented instructions and header
<!--
Thank you πŸ™ for your contribution to Ultralytics πŸš€! Your effort in enhancing our repositories is greatly 
appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, fill out 
all relevant sections.
-->
  • Provides sections for users to provide relevant information in an organized manner
  • Includes Checklist section of items to complete for each PR
  • Add optional sections for media and performance/test results

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

πŸ“Š Key Changes

  • The PR template has undergone a substantial expansion from 4 main points to a more detailed checklist, tips, and sections for bug fixes and feature additions.
  • New sections include "Summary of Changes," "Link Issues," "Relevant Discussions," "Rationale/Justification," "Checklist," "Known/lingering Problems," "Relevant media," and "Results."

🎯 Purpose & Impact

  • The updated template aims to guide contributors to provide more thorough information with their PRs, ensuring each submission is unique and well-justified.
  • Improvements can result in higher quality contributions, easier maintenance, and more efficient PR review processes, benefiting developers and enhancing the software for users. 🌟

🌟 Summary

"Update to PR template to foster comprehensive and informed submissions, promoting project clarity and quality."

@Burhan-Q
Copy link
Member Author

Burhan-Q commented Jan 6, 2024

Reference for the highlighted block sections

Block Highlight Previews

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

@Burhan-Q
Copy link
Member Author

Burhan-Q commented Jan 6, 2024

Added sub-section for linking Community Discussions as recommend by @RizwanMunawar

@Burhan-Q Burhan-Q added the enhancement New feature or request label Jan 6, 2024
@glenn-jocher
Copy link
Member

@Burhan-Q thanks for the effort here, I've just merged a super simple PR to comment the guidance as it's extra work to delete this and many people just never submit any written summary.

This should combine with our new PR summaries soon that should help automate understanding and review of PRs.

@glenn-jocher
Copy link
Member

Reference for the highlighted block sections

Block Highlight Previews

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Very cool, did not know!

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

Successfully merging this pull request may close these issues.

None yet

2 participants