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.

Sign up for GitHub

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

Docs(repo): Edit contributing guide #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs(repo): Edit contributing guide #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ This project uses GitHub Actions to publish the packages automatically to npm. N

### Steps to create a new package version

1. Merge all appropriate PRs you want to publish into main branch
1. Run the `make version` command to bump the version number in packages (new version number is determined automatically based on commit history)
1. Please, manually edit commit message according [commit guidelines](#commit-messages) to ensure proper version and changelog
1. Merge all appropriate PRs you want to publish into `main` branch
1. Checkout to the `main` branch and run the `make version` command to bump the version number in packages (new version number is determined automatically based on commit history)
1. Check that the version number is correct and everything looks good
1. Run manually `git push && git push --tags` to push the changes to remote
1. Publishing is done automatically by GitHub Actions (uses `build` script and `make publish` command)
Comment on lines +27 to 32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having 1 everywhere is easier to edit, but harder to read… It's up to you to decide what matters more 🙂.

Expand Down