Sections

This guide explains the purpose of each section in the PR template and provides tips on how to fill it out properly.

How to Use

This document provides a comprehensive set of PR template sections that can be used to standardize and streamline the pull request process across different repositories.

Building Yours

• You don’t have to use all sections—simply select the ones that best fit your repository’s needs.
• Each section is designed to cover different aspects of a PR, such as summary, testing, dependencies, rollback plans, and more.
• Feel free to reorder or modify sections to match your team’s workflow.

How to Implement

1. Create the PR template file in your repository and place it in .github/pull_request_template.md.
2. Browse the sections below and choose the ones relevant to your repository.
3. Copy and paste the selected sections into your repository’s PR template file.
4. Customize the sections as needed to reflect specific requirements, but keep the structure intact.

By using a structured PR template, your team can ensure clearer communication, faster reviews, and a more efficient development process.

Sections

• 🎯 Summary
• 🔍 Related Issues/Tickets
• 📝 Description of Changes
• 🚀 Changes Introduced
• 🔄 Type of Change
• 🧪 How Has This Been Tested?
• ✅ Checklist
• 📸 Screenshots / Demo
• 🔗 Dependencies
• ⏳ Deployment Considerations
• ⚠️ Risks & Rollback Plan
• ⏳ Rollback Plan
• 📚 Additional Context
• 👥 Reviewers
• 🚀 Ready for Merge?
• ✅ Checklist Before Merge
• 🏁 Next Steps

🎯 Summary

Provides a high-level overview of the changes introduced in the PR.

What to include?

• A concise description of the changes.
• The problem being solved or the goal of the PR.

## 🎯 Summary
 
<!-- Provide a concise description of the change -->

🔍 Related Issues/Tickets

Links the PR to existing issues, tickets, or user stories for better tracking.

What to include?

• Issue or ticket number.
• A brief reference to the issue.

## 🔍 Related Issues/Tickets
 
<!-- Link to any relevant issues or tickets (e.g., "Closes #123") -->

📝 Description of Changes

Explains in detail what was changed and why.

What to include?

• A summary of the implemented changes.
• The reason for the changes. (e.g., bug fix, improvement, feature addition)
• Potential impacts or trade-offs.

## 📝 Description of Changes
 
<!-- Provide details of what has been changed, why, and any implications -->

🚀 Changes Introduced

Provides a checklist of the types of changes introduced in this PR.

What to include?

• Mark the appropriate categories of changes.
• If “Other” is selected, specify the type.

## 🚀 Changes Introduced
 
<!-- A concise list of changes made in this PR -->
 
- \[ ] New feature added
- \[ ] Bug fix
- \[ ] Code refactor
- \[ ] Documentation update
- \[ ] Other (please specify):

🔄 Type of Change

Clarifies the nature of the changes, making it easier for reviewers to assess the PR.

What to include?

• Select the most relevant type(s) of changes.

## 🔄 Type of Change
 
- \[ ] 🆕 New Feature
- \[ ] 🐛 Bug Fix
- \[ ] 📄 Documentation Update
- \[ ] 🔨 Refactor
- \[ ] 🧪 Tests
- \[ ] ♻️ Code Cleanup

🧪 How Has This Been Tested?

Describes the testing performed to ensure the changes work correctly.

What to include?

• Types of tests executed.
• Results of the tests.

## 🧪 How Has This Been Tested?
 
- \[ ] Unit tests
- \[ ] Integration tests
- \[ ] Manual testing
- \[ ] Other (describe below)

✅ Checklist

Ensures that the PR meets all necessary quality and compliance checks before merging.

What to include?

• A checklist to confirm all required steps are completed.

## ✅ Checklist
 
- \[ ] My code follows the project’s style guidelines
- \[ ] I have performed a self-review of my code
- \[ ] I have commented my code where necessary
- \[ ] I have added relevant tests
- \[ ] All new and existing tests pass
- \[ ] I have updated the documentation as needed
- \[ ] This PR includes necessary version updates (if applicable)

📸 Screenshots / Demo

Provides visual evidence of UI changes, new features, or fixes.

What to include?

• Screenshots, GIFs, or a link to a live demo.

## 📸 Screenshots / Demo
 
<!-- Include screenshots, GIFs, or links to relevant resources -->

🔗 Dependencies

Lists any external dependencies added or updated in this PR.

What to include?

• Package/library name.
• Version information.
• Reason for the dependency.

## 🔗 Dependencies (if applicable)
 
<!-- List any dependencies added or updated in this PR -->

⏳ Deployment Considerations

Identifies any required actions before or after deployment.

What to include?

• Database migrations.
• Environment variable updates.
• Feature flag requirements.

## ⏳ Deployment Considerations
 
- \[ ] Requires database migration
- \[ ] Requires environment variable updates
- \[ ] Requires feature flag

⚠️ Risks & Rollback Plan

Identifies potential risks and provides a rollback strategy.

What to include?

• Possible issues that may arise.
• Steps to revert the changes if needed.

## ⚠️ Risks & Rollback Plan
 
<!-- What risks are associated with this change? How can we revert safely? -->

⏳ Rollback Plan

Provides a specific plan to revert the changes if necessary.

What to include?

• Steps to undo the deployment.
• Any backup/restoration measures.

## ⏳ Rollback Plan
 
<!-- Describe a plan in case the changes need to be reverted -->

📚 Additional Context

Allows adding any extra information that helps reviewers understand the PR.

What to include?

• Links to relevant documentation.
• Insights that may help with review.

## 📚 Additional Context
 
<!-- Add any other context or information about this PR -->

👥 Reviewers

Suggests who should review the PR.

What to include?

• Team members or individuals who should review.

## 👥 Reviewers
 
<!-- Suggest reviewers for this PR -->
 
@mention-team @mention-individual

🚀 Ready for Merge?

Indicates if the PR is fully ready or still needs changes.

What to include?

• Confirmation that all required checks have passed.

## 🚀 Ready for Merge?
 
- \[ ] Yes, all tests pass!
- \[ ] Not yet, needs review

✅ Checklist Before Merge

Ensures all essential steps are completed before merging.

What to include?

• Final verification steps.

## ✅ Checklist Before Merge
 
- \[ ] Tests added and passing
- \[ ] Documentation updated
- \[ ] Changes reviewed by at least one team member

🏁 Next Steps

Provides information on follow-up tasks after merging.

What to include?

• Further development steps.
• Deployment plans.

## 🏁 Next Steps
 
<!-- What happens after this PR? -->