Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.21 KB
Raw

Contributing

Setup

In order to get started with the project make sure you have the following installed:

  • Node.js v14 or newer and npm v8.5 or newer
  • The Twilio CLI
  • git

To setup the project run:

git clone https://github.com/twilio-labs/plugin-webhook.git
cd plugin-webhook
npm install
twilio plugins:link .

This will clone the project repository, install the dependencies and connect your local plugin version to the CLI so you can use it. To check if everything works try to run:

twilio webhook:invoke --help

To validate that it's using your local version run twilio plugins and check if it says (link) and the path to your folder next to the plugin.

Running Tests

To run the test suite run:

npm test

The tests are also automatically run when you open a pull request and on any merges to main.

Committing and opening a pull request

After you have performed the intended changes and have successfully run the tests you can commit your changes.

Before you open a pull request, if your changes apply to anything that would require a new release of the package (for example changes in src/), please run the following command to describe your changes:

npm run changeset

Afterwards run:

git add .changeset
git commit -m "docs: add changeset updates"

This will make sure that your changes will appear in the changelog and that we can create a new release.

Once you are done, push your changes to a branch on your forked repository and open a pull request in the repository.

For Maintainers

Version bumps are handled automatically by this GitHub Action whenever changes have been merged to main. If the automation will detect any changeset files inside the .changeset directory it will either open a new Pull Request to bump the version or force-push to the currently open Pull Request. In order to release to npm you'll have to merge that Pull Request which will automatically kick off the release.

Code of Conduct

All contributions and interactions with this project fall under our Code of Conduct