Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eyadmba committed Apr 17, 2024
1 parent b864f11 commit 545f8db
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,14 @@ is:
## Versioning this package

The following needs to be the last commit on your branch right before merging to
main. That's crucial to the CI process. \
If you encounter issues while doing the following procedure, rebasing won't work,
you'll need to start it over again because of how tags work.

1. Update the `CHANGELOG.md` file with the new version number and the changes
made in that version.
2. Stage your changes, and as the last commit, run `yarn version` to bump the
package number and tag the commit.
3. Push your changes.
made in that version. Don't commit the change.
2. Stage the changes of the changelog and then run `yarn version` to commit the
changes to the changelog, and bump the package number. This will also tag
said commit locally on your branch.
3. Push your changes. Merge to main.

0 comments on commit 545f8db

Please sign in to comment.