Getting Started
Welcome to the Pull Request (PR) Templates documentation! This guide helps you understand how to configure and customize PR templates for different repository needs.
Understand PR Sections
- PR templates are composed of modular sections that cover different aspects of a pull request.
- You can pick and choose from a set of predefined sections to construct your own template.
Select and Configure Your PR Template
- Browse the PR Sections List to find the available sections.
- Copy and arrange them in the order that makes sense for your repository.
Use Pre-Configured Templates (Recommended)
- Instead of manually assembling a template, you can use ready-made PR templates built for specific purposes.
- We provide examples like:
- Standard PR Template - A well-balanced template for general-purpose repositories.
- DevOps & CI/CD PR Template - A template tailored for infrastructure, pipeline, and deployment-related changes.
Available Resources
| Resource | Description |
|---|---|
| PR Sections List | A modular list of PR sections to construct your own template |
| Standard PR Template | A pre-configured PR template for general repositories |
| DevOps PR Template | A pre-configured PR template for infrastructure and CI/CD changes |
Best Practices
- Keep PRs concise and well-structured\
- Use clear checklists to improve the review process\
- Always link related issues or tickets for better tracking\
- Select a template that best fits your workflow
By using structured PR templates, your team can improve collaboration, enhance review efficiency, and maintain code quality across all repositories.
📢 Need Help?
If you have any questions or need modifications, feel free to reach out in our Slack channel #eng-practices ! Happy coding! 😊
Last updated on