Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.25 KB

Contributing

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: yarn install
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change, add tests, and make sure the tests still pass: yarn test
  5. Run the linter and fix any new complaints: yarn lint
  6. Make sure your code is correctly formatted: yarn format
  7. Update dist/index.js using yarn package. This creates some files that is used as an entrypoint for the action
  8. Push to your fork and submit a pull request
  9. 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!