Skip to content

ER: Proposed edits to Pull Request template #6929

@t-will-gillis

Description

@t-will-gillis

Emergent Requirement - Problem

Many of the same errors appear in PRs, and some of these errors might be adverted by making minor changes to the PR template. Please see below

Issue you discovered this emergent requirement in

Date discovered

6/2/24

Did you have to do something temporarily

  • YES
  • NO

Who was involved

@t-will-gillis

What happens if this is not addressed

We will continue to have errors needing to be addressed in PR reviews.

Resources

pull_request_template.md

Recommended Action Items

  • Make a new issue
  • Discuss with team
  • Let a Team Lead know

Potential solutions [draft]

  • To address a problem where devs do not link an issue to "Fixes: # ":
    • Add comment above "Fixes " line:
      <!-- Important! Add the number of the issue you worked on after Fixes # -->
    • We could also incorporate this workflow in the Lucky Parking project that posts a message if the dev doesn't link an issue. Probably would need to be integrated with set-pr-labels
  • To address the case when devs forget to add spaces after the tics in the 'what did you do and why' sections, add single space after each tic mark so that dev is beginning with the space already
  • Additionally, add a comment after the "What did you do.." and the "Why did you do it" that says:
    <!-- Note: add lines if needed, and remove any unused lines -->
  • To address the case where devs fail to remove the code after "Screenshots.." , modify the notes to:
    <!-- Notes: 
    - If there are no visual change to the website, delete all of the script below and replace with "- No visual changes" or similar
    - If your images are too big, use the <img src="" width="" length="" />  syntax instead of ![image](link) to format the images
    - If images are not loading properly, you might need to double check the syntax or add a newline after the closing </summary> tag 
    -->  
    

Example of propsed PR Template

Metadata

Metadata

Assignees

Labels

Complexity: See issue making labelSee the Issue Making label to understand the issue writing difficulty levelComplexity: SmallTake this type of issues after the successful merge of your second good first issueEREmergent RequestFeature: Board/GitHub MaintenanceProject board maintenance that we have to do repeatedlyIssue Making: Level 2Make issue(s) from an ER or Epicrole: back end/devOpsTasks for back-end developerssize: 0.25ptCan be done in 0.5 to 1.5 hours

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions