Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
donmccurdy committed Jan 22, 2025
1 parent a58a86f commit 16bd03d
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Contributing

_Contributions are subject to CARTO's [community contributions policy](https://carto.com/contributions/)._

## Local development requirements

- Yarn v4+
- Node.js v18+

## Quickstart

To install and build `quadbin-js` locally from source:
Expand All @@ -19,6 +28,12 @@ yarn test

## Releases

1. Create a new version: `yarn version [ major | minor | patch | prerelease ]`
1. Update changelog

2. Create a new version: `yarn version [ major | minor | patch | prerelease ]`

3. Commit, tag, and push to GitHub: `yarn postversion`

2. Execute `yarn publish`
4. Publish
- If working on `master`, the previous step will automatically create and push a branch. Open a pull request, get any required approvals, and merge. Merged pull requests with commit messages beginning `chore(release)` will trigger a release automatically.
- If working on a branch, a commit for the release will be pushed to the branch. You'll then need to [manually run a workflow](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow), “Release”, selecting the target branch in the menu.

0 comments on commit 16bd03d

Please sign in to comment.