diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47931d23b..2591549ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,4 +55,25 @@ accept your pull requests. npm run fix -[node]: https://nodejs.org/en/ \ No newline at end of file +## Testing a new feature using CLI + +1. After you've written some new code, in order to test it out, you can use the [CLI][CLI]. + + The below command should be run from the root of the source code: + + ``` + node build/src/bin/release-please.js release-pr \ + --token=$GITHUB_TOKEN \ + --repo-url=/ [extra options] + ``` + + It is equivalent to running the CLI command: + + ``` + release-please release-pr \ + --token=$GITHUB_TOKEN \ + --repo-url=/ [extra options] + ``` + +[node]: https://nodejs.org/en/ +[CLI]: https://github.com/googleapis/release-please/blob/main/docs/cli.md/