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

fix: add further information to the README around the publishing workflow #303

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

assadk88
Copy link
Contributor

@assadk88 assadk88 commented Oct 3, 2024

How to review this PR

Leave this text block for the reviewer

  • Check component hierarchy is followed correctly
  • Check the design Heuristics have been followed
  • Check naming conventions have been applied
  • Check for these gotchyas:
    • Missing exports for Oak components
    • Accidental export of Internal components
    • Snapshots of unexpected components have been modified
    • Circular dependencies
    • Code duplication (via not using base components)
    • Non-functional storybook for this or related components
    • Sensitve files changed eg. atoms, or style tokens
    • Relative imports
    • Default exports

Add your PR description below

Updated the README to contain extra information around the publishing workflow

Testing instructions

  • Review the README changes and ensure clarity around the commit message conventions.
  • Verify that the summary of commit types (patch, minor, major) aligns with the project's semantic release process.

ACs

  • README accurately describes the Conventional Commits format for releases.
  • Explanation of major, minor, and patch versions is clear and understandable.
  • Reviewer is able to understand which commit messages trigger which type of release.

Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for lively-meringue-8ebd43 ready!

Name Link
🔨 Latest commit ad36f0e
🔍 Latest deploy log https://app.netlify.com/sites/lively-meringue-8ebd43/deploys/66fe920e944c770008560bee
😎 Deploy Preview https://deploy-preview-303--lively-meringue-8ebd43.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@assadk88 assadk88 force-pushed the fix/add-publishing-guidance-to-readme branch from 40a60f3 to ad36f0e Compare October 3, 2024 12:46
Copy link

sonarqubecloud bot commented Oct 3, 2024

@assadk88 assadk88 merged commit 61278a3 into main Oct 3, 2024
8 checks passed
@assadk88 assadk88 deleted the fix/add-publishing-guidance-to-readme branch October 3, 2024 12:51
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.

2 participants