This document provides a basic guide on how to create a Pull Request (PR) template for our project.

Table of Contents

What is a PR Template?

A PR template is a standardized format for creating Pull Requests in a project. It helps maintain consistency across all PRs and makes it easier for reviewers to understand the changes being proposed.

Why Use a PR Template?

  • Consistency: Ensures that all PRs follow the same structure, making them easier to review.
  • Clarity: Provides a clear outline of the changes being made, making it easier for reviewers to understand the impact.
  • Efficiency: Reduces the time spent on review and discussion by providing all necessary information upfront.

Creating a PR Template

  1. Choose a Template: You can use an existing template or create your own.
  2. Include Basic Information: This should include the PR title, description, and the branch you're creating the PR from.
  3. List Changes: Provide a detailed list of the changes you've made, including code snippets and explanations.
  4. Add Screenshots or Videos: If applicable, include screenshots or videos demonstrating the changes.

Formatting Your PR

  • Use Clear and Concise Language: Make sure your PR description and code comments are easy to understand.
  • Follow Coding Standards: Adhere to the project's coding standards to ensure consistency.
  • Include Tests: If applicable, include tests to verify the changes.

Additional Resources

For more information on creating and managing PRs, check out our PR Guide.

Code Review