Skip to content

chore: add jira board reference and screenshots to the pull request t…#122

Merged
fernandatoledo merged 2 commits intomasterfrom
chore/update_pr_template
Jun 12, 2025
Merged

chore: add jira board reference and screenshots to the pull request t…#122
fernandatoledo merged 2 commits intomasterfrom
chore/update_pr_template

Conversation

@fernandatoledo
Copy link
Copy Markdown
Collaborator

…emplate

What does this do?

This PR updates the PULL REQUEST template file.

Why did you do this?

As part of a one of our React Native community roundtables we had a discussion about code review. What were some challenges we faced while reviewing some of our pull requests. One of the things that came up was how sometimes the description of the pull request did not provide with the necessary information to make an accurate review of the introduced changes.

  • Not every reviewer has access to a JIRA board and so the link to a ticket is not enough, the information should be part of the description of the pull request.

Who/what does this impact?

This would have an impact on the experience of code reviewers.

How did you test this?

A template very similar to this was used in a Rootstrap Project for about 3 months and positive feedback was gathered from the code reviewers of that project.

@github-actions
Copy link
Copy Markdown

github-actions bot commented May 16, 2025

💯 Test Coverage

Lines Statements Branches Functions
Coverage: 50%
50% (341/682) 44.52% (122/274) 36.32% (85/234)

😎 Tests Results

Tests Skipped Failures Errors Time
77 0 💤 0 ❌ 0 🔥 31.337s ⏱️
👀 Tests Details • (50%)
File% Stmts% Branch% Funcs% LinesUncovered Line #s
All files5044.5236.3250.38 
report-only-changed-files is enabled. No files were changed in this commit :)

Copy link
Copy Markdown
Collaborator

@asdolo asdolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love these changes, thanks 🙌 !

Just one little thing. In the CLI project we have a script that searchs for the "What does this do?" section and we remove all text found above that match. Since now we have the new "Jira board reference" section above we may need to change the CLI script to search for that section instead.

You can view it over here:

searchValue: /^[\s\S]*?(?=## What does this do\?)/,

@fernandatoledo fernandatoledo requested a review from asdolo May 16, 2025 14:00
@fernandatoledo fernandatoledo requested review from ManuViola77 and nicmalegre and removed request for juanchoperezj June 6, 2025 18:14
@fernandatoledo fernandatoledo merged commit 7cb3332 into master Jun 12, 2025
8 checks passed
@fernandatoledo fernandatoledo deleted the chore/update_pr_template branch June 12, 2025 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants