Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (51 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 3.77 KB

Contributing

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.

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change, add tests, and make sure the tests still pass
  4. Push to your fork and submit a pull request
  5. 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.

Cutting a new release

Details

Note: these instructions are for maintainers

  1. Update the version number in package.json and run npm i to update the lockfile. This is also a good time to make sure that the dist/index.js file is up to date by running npm run build.
  2. Go to Draft a new release in the Releases page.
  3. Make sure that the Publish this Action to the GitHub Marketplace checkbox is enabled
Screenshot 2022-06-15 at 12 08 19
  1. Click "Choose a tag" and then "Create new tag", where the tag name will be your version prefixed by a v (e.g. v4.1.2).
  2. Use a version number for the release title (e.g. "4.1.2").
Screenshot 2022-06-15 at 12 08 36
  1. Add your release notes. If this is a major version make sure to include a small description of the biggest changes in the new version.
  2. Build the release executables by manually triggering this action. The output of this action will be a zip file that you should download, extract, and drag into the binaries section. There should be three files there: ending in -linux, -macos, and -win.exe.
  3. Click "Publish Release".

You now have a tag and release using the semver version you used above. The last remaining thing to do is to move the dynamic version identifier to match the current SHA. This allows users to adopt a major version number (e.g. v1) in their workflows while automatically getting all the minor/patch updates.

To do this just checkout main, force-create a new annotated tag, and push it:

git tag -fa v5 -m "Updating v5 to 5.0.0"
git push origin v5 --force

Resources