Skip to content

chore: sync pr template from backend#363

Merged
nibalizer merged 1 commit intomainfrom
nibz/chore_pr_template
May 1, 2025
Merged

chore: sync pr template from backend#363
nibalizer merged 1 commit intomainfrom
nibz/chore_pr_template

Conversation

@nibalizer
Copy link
Contributor

Internal Notes for Reviewers

This updates the PR Template per discussion on https://github.com/validmind/backend/pull/1386

External Release Notes

@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2025

PR Summary

This pull request updates the GitHub pull request template to include more detailed sections and a comprehensive checklist. The changes aim to improve the clarity and completeness of PR descriptions, ensuring that all necessary information is provided for reviewers and stakeholders.

Key Changes:

  • Added sections for describing the change (What), the rationale behind it (Why), and testing instructions (How to Test).
  • Introduced a checklist to ensure that all critical aspects of the PR are addressed, including release notes, deployment notes, breaking changes, and testing.
  • Removed the chore label from the release notes instructions.
  • Added sections for deployment notes, breaking changes, and frontend-specific media (screenshots/videos).
  • Included a section for additional notes and areas needing special review.

Test Suggestions

  • Verify that the new PR template renders correctly in the GitHub interface.
  • Ensure that all new sections in the template are clear and provide the necessary guidance for contributors.
  • Check that the checklist items are relevant and comprehensive for typical PRs in the project.
  • Test the template by creating a mock PR and filling out each section to ensure usability.

@nibalizer nibalizer added the internal Not to be externalized in the release notes label May 1, 2025
Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great 👌

@nibalizer nibalizer merged commit bf0a249 into main May 1, 2025
7 of 8 checks passed
@johnwalz97 johnwalz97 deleted the nibz/chore_pr_template branch August 20, 2025 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants