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

chore: aligning release docs with latest #634

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Conversation

georgewrmarshall
Copy link
Collaborator

@georgewrmarshall georgewrmarshall commented Feb 24, 2024

Description

This PR updates the "Release" section of the README to align with the latest GitHub Actions workflows and processes in the module template. The motivation behind this change is to ensure that our documentation accurately reflects the current practices and procedures for releases, making it easier for both new and existing contributors to understand and participate in the release process.

Related issues

Fixes: #633

Manual testing steps

  1. Review the updated "Release" section in the README for clarity and accuracy.
  2. Make sure it aligned with the module template

Screenshots/Recordings

Before

Screenshot 2024-02-25 at 11 42 30 AM

After

Screenshot 2024-02-25 at 11 41 04 AM

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained what problem this PR is solving and how it is solved.
  • I've linked related issues.
  • I've included manual testing steps.
  • I've included screenshots/recordings if applicable.
  • I’ve included tests if applicable.
  • I’ve documented my code using JSDoc format if applicable.
  • I’ve applied the right labels on the PR.
  • I’ve properly set the pull request status to "ready for review".

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g., review the README, follow the steps, check the links).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as screenshots.

@georgewrmarshall georgewrmarshall added documentation Improvements or additions to documentation code Issue related to code work team-design-system All issues relating to design system labels Feb 24, 2024
@georgewrmarshall georgewrmarshall self-assigned this Feb 24, 2024
@georgewrmarshall georgewrmarshall marked this pull request as ready for review February 24, 2024 22:43
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner February 24, 2024 22:43
@georgewrmarshall georgewrmarshall merged commit 279fe5a into main Feb 27, 2024
17 checks passed
@georgewrmarshall georgewrmarshall deleted the update-release-docs branch February 27, 2024 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Issue related to code work documentation Improvements or additions to documentation team-design-system All issues relating to design system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Align release docs with module template
2 participants