Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.59 KB

Contributions

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.

Submitting a pull request

  1. Fork and clone the repository
  2. Use Node.js version specified in the .nvmrc file: nvm use
  3. Configure and install the dependencies: npm install
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests still pass: npm run test
  6. Make sure your code passes lint checks: npm run lint
  7. Update dist/index.js using npm run build. This creates a single javascript file that is used as an entrypoint for the action
  8. Push to your fork and submit a pull request
  9. 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.

Resources