Skip to content

Commit

Permalink
feat: update contribution doc (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
tiavina-mika authored Jun 12, 2024
1 parent 7445a01 commit b473a28
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ To instead test a "built" version of this package which is installed into an "ex
When a new version should be cut since some new changes have landed on the `main` branch, do the following to publish it:

1. Go to the `main` branch and pull in the latest changes.
2. Commit change using (commit convention)[https://nanthakumaran.medium.com/conventional-commits-simplify-your-project-history-and-automate-tasks-29007273e198]
2. Commit change using (commit convention)[https://www.conventionalcommits.org/en/v1.0.0-beta.4/]
3. Push the commit (ex: `git push origin main`)
5. The `release.yml` GitHub Actions workflow will auto-generate a tag, change log, release note and a PR branch
6. The `automerge.yml` GitHub Actions workflow will merge and delete the PR branch
7. The `publish.yml` GitHub Actions workflow will publish the package to the npm registry
4. The `release.yml` GitHub Actions workflow will auto-generate a tag, change log, release note and a PR branch
5. The `automerge.yml` GitHub Actions workflow will merge and delete the PR branch
6. The `publish.yml` GitHub Actions workflow will publish the package to the npm registry

## Issue possibly encountered during installation
- [with yarn](https://stackoverflow.com/questions/67062308/getting-yn0028-the-lockfile-would-have-been-modified-by-this-install-which-is-e)
Expand Down

0 comments on commit b473a28

Please sign in to comment.