🎉 First off, thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to this repository.
- Fork and clone this repository. If you're not sure how to do it follow this getting started guide.
- Node.js installed with a version greater or equal to 20.
Run npm ci to install dependencies
You can either use npm run start to start the main.ts file, or use the act tool to run the GitHub action locally.
We use prettier and eslint to format and lint our code.
Before submitting a PR please run npm run format and npm run lint to ensure your code matches our style.
Once you submit a PR, a bunch of CI tests will run on it PR and ensure existing functionally works as expected.
It's always recommended to open an issue first to discuss changes. This ensures PRs are reviewed, merged and shipped as fast as possible.
To release a new version simply merge the release PR (visit this PR for an example). Once the release PR is merged a new tag and release will be created automatically. Once the release is created you'll need to manually publish it to the GitHub Actions Marketplace by editing the release.
For example follow this link to edit v1.0.4:
Ensure the Publish this Action to the GitHub Marketplace checkbox is checked, and click Update release at the bottom:
