Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are released to the public under the project's open source license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone the repository
- Configure and install the dependencies:
script/bootstrap - Make sure the tests pass on your machine:
rake - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
Publishing requires write access to the repository.
- Run
npm version <version> --no-git-tag-versionto update the version inpackage.jsonandpackage-lock.json. - Open a pull request with the version change and merge it into the default branch.
- Create a GitHub release from the merged commit, using the new version as the tag (for example,
3.3.0). - Confirm that the Publish workflow completes successfully. Creating the release triggers this workflow, which publishes the package to npm.
To publish an existing version tag without creating another release:
- Open the Publish workflow.
- Select Run workflow.
- Enter the existing version tag in Existing tag version to publish and run the workflow.
- Confirm that the workflow completes successfully.
The same workflow can be started with GitHub CLI:
gh workflow run publish.yml --field tag_version=<version>