All contributors must first sign the Particle Individual Contributor License Agreement (CLA), which is based on the Google CLA, and provides the Particle team a license to re-distribute your contributions.
- Fork and clone the repository
- Use Node.js version specified in the
.nvmrc
file:nvm use
- 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 passes lint checks:
npm run lint
- Update
dist/index.js
usingnpm 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
- 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:
- Keep each pull request small and focused on a single feature or bug fix.
- Familiarize yourself with the code base, and follow the formatting principles adhered to in the surrounding code.
- Wherever possible, provide unit tests for your contributions.