Skip to content

Minor improvements to the PR template #17782

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

Merged
merged 4 commits into from
Jun 2, 2025
Merged

Minor improvements to the PR template #17782

merged 4 commits into from
Jun 2, 2025

Conversation

SaschaCowley
Copy link
Member

@SaschaCowley SaschaCowley commented Mar 7, 2025

Link to issue number:

Closes #17616

Summary of the issue:

There is inconsistent use of colons (":") after prompts in the PR template.

Description of user facing changes

  • The PR template now has colons following all prompts
  • The PR template now has a new "Developer facing changes" section
  • The PR template now reminds users to use "Closes"/"Fixes"/"Resolves" to link the targetted issue
  • The Pull Request Template Explanation and Examples document has been updated

Description of development approach

Read templates and made adjustments as necessary.
Read the template documentation, making minor fixes and documenting the new section.

Testing strategy:

Proof-read templates.

Known issues with pull request:

Users may dislike the change

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Apr 1, 2025
@SaschaCowley SaschaCowley changed the title Tidy up the PR template Minor improvements to the PR template May 16, 2025
@SaschaCowley SaschaCowley marked this pull request as ready for review May 16, 2025 07:22
@SaschaCowley SaschaCowley requested a review from a team as a code owner May 16, 2025 07:22
@SaschaCowley SaschaCowley requested a review from seanbudd May 16, 2025 07:22
@seanbudd
Copy link
Member

@SaschaCowley - can you resolve conflicts

@SaschaCowley
Copy link
Member Author

@seanbudd done

@seanbudd seanbudd merged commit 73f212d into master Jun 2, 2025
15 checks passed
@seanbudd seanbudd deleted the prTemplate branch June 2, 2025 04:31
@github-actions github-actions bot added this to the 2025.2 milestone Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve consistency of issue and PR templates
2 participants