Contributing

Submitting a pull request

Fork and clone the repository
Configure and install the dependencies: npm install
Create a new branch: git checkout -b my-branch-name
Make your change, add tests, and make sure the tests still pass: npm run test
Make sure your code is correctly formatted: npm run format
Update dist/index.js using npm run build. This creates a single javascript file that is used as an entrypoint for the action
Push to your fork and submit a pull request
Pat yourself 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.

Resources

Thanks! ❤️ ❤️ ❤️

GitHub Actions Team