Skip to content

Instantly share code, notes, and snippets.

@Victor1890

Victor1890/pr_template.md

Forked from nicolasmontielf/pr_template.md
Created April 8, 2024 11:49
Show Gist options
  • Save Victor1890/43b6ff2a5fba2907a4193178102aed5a to your computer and use it in GitHub Desktop.
Save Victor1890/43b6ff2a5fba2907a4193178102aed5a to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @nicolasmontielf nicolasmontielf created this gist Feb 18, 2024.
    14 changes: 14 additions & 0 deletions pr_template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,14 @@
    ## Context
    *Gives the reviewer some context about the work and why this change is being made, the WHY you are doing this. This field goes more into the product perspective.*

    ## Description
    *Provide a detailed description of how exactly this task will be accomplished. This can be something technical. What specific steps will be taken to achieve the goal? This should include details on service integration, job logic, implementation, etc.*

    ## Changes in the codebase
    *This is where becomes technical. Here is where you can be more focused on the engineering side of your solution. Include information about the functionality they are adding or modifying, as well as any refactoring or improvement of existing code.*

    ## Changes outside the codebase
    *If you have made changes to external services, need to add additional values to the job settings, or need to add something new to the database, explain it here. This may include updates to third-party services, changes to infrastructure configuration, integration with external APIs, etc.*

    ## Aditional information
    *Provide any additional information that might be useful to the reviewer in evaluating this pull request. This could include performance considerations,design choices, etc.*