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: Update README with pre-release and release instructions #726

Merged
merged 2 commits into from
Dec 12, 2022

Conversation

engfragui
Copy link
Contributor

@engfragui engfragui commented Dec 12, 2022

Short description

This PR updates the README file to include more detailed pre-release and release instructions.

This was inspired by @gnapse's thorough comment, explaining me how to release the reactist package: #712 (comment)

PR Checklist

  • Added tests for bugs / new features
  • Updated docs (storybooks, readme)
  • Executed npm run validate and made sure no errors / warnings were shown
  • Described changes in CHANGELOG.md
  • Bumped version in package.json and package-lock.json (npm --no-git-tag-version version <major|minor|patch>) ref
  • Updated all static build artifacts (npm run build-all)

Versioning

Does not require a new version, as this is just a README update.

@engfragui engfragui self-assigned this Dec 12, 2022
@engfragui engfragui added the Show label Dec 12, 2022
@engfragui engfragui marked this pull request as ready for review December 12, 2022 15:54
@engfragui engfragui requested a review from gnapse December 12, 2022 16:01
@engfragui engfragui merged commit 2467bc0 into main Dec 12, 2022
@engfragui engfragui deleted the francesca/readme-update branch December 12, 2022 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant