Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updating PR template #7578

Merged
merged 2 commits into from
Oct 23, 2023
Merged

docs: Updating PR template #7578

merged 2 commits into from
Oct 23, 2023

Conversation

georgewrmarshall
Copy link
Contributor

Description

Currently the PR template although comprehensive, could be improved with the intention of easing engineer workflow by removing italics, rearranging the sections and making the author checklist more concise and use the same language as the template itself.

Manual testing steps

  1. Read the PR template
  2. Imagine filling it out
  3. Do you feel it would help or hinder when creating a PR?
  4. Comment with input

Screenshots/Recordings

Before

Screenshot 2023-10-23 at 12 12 49 PM

After

Screenshot 2023-10-23 at 12 12 34 PM

Related issues

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained:
    • What problem this PR is solving.
    • How this problem was solved.
    • How reviewers can test my changes.
  • I’ve indicated what issue this PR is linked to: Fixes #???
  • I’ve included tests if applicable.
  • I’ve documented any added code.
  • I’ve applied the right labels on the PR (see labeling guidelines).
  • I’ve properly set the pull request status:
    • In case it's not yet "ready for review", I've set it to "draft".
    • In case it's "ready for review", I've changed it from "draft" to "non-draft".

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@github-actions
Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@georgewrmarshall georgewrmarshall changed the title Updating PR Template docs: Updating PR Template Oct 23, 2023
@georgewrmarshall georgewrmarshall changed the title docs: Updating PR Template docs: Updating PR template Oct 23, 2023
@georgewrmarshall georgewrmarshall added the team-design-system All issues relating to design system in Mobile label Oct 23, 2023
Copy link
Member

@cortisiko cortisiko left a comment

Choose a reason for hiding this comment

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

✅ ✅

Copy link
Contributor

@sethkfman sethkfman left a comment

Choose a reason for hiding this comment

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

LGTM

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e6e53a5) 34.72% compared to head (c2e73ba) 34.72%.

❗ Current head c2e73ba differs from pull request most recent head 9551492. Consider uploading reports for the commit 9551492 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7578   +/-   ##
=======================================
  Coverage   34.72%   34.72%           
=======================================
  Files        1020     1020           
  Lines       27252    27252           
  Branches     2229     2229           
=======================================
  Hits         9463     9463           
  Misses      17292    17292           
  Partials      497      497           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@georgewrmarshall georgewrmarshall merged commit 5a4acf6 into main Oct 23, 2023
25 checks passed
@georgewrmarshall georgewrmarshall deleted the update-pr-template branch October 23, 2023 20:16
@github-actions github-actions bot locked and limited conversation to collaborators Oct 23, 2023
@metamaskbot metamaskbot added the release-7.11.0 Issue or pull request that will be included in release 7.11.0 label Oct 23, 2023
@georgewrmarshall georgewrmarshall self-assigned this Oct 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release-7.11.0 Issue or pull request that will be included in release 7.11.0 team-design-system All issues relating to design system in Mobile team-mobile-platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants