diff --git a/packages/generate-bot/__snapshots__/generate-bot.js b/packages/generate-bot/__snapshots__/generate-bot.js index 3452476090b..b08d059186b 100644 --- a/packages/generate-bot/__snapshots__/generate-bot.js +++ b/packages/generate-bot/__snapshots__/generate-bot.js @@ -1,19 +1,20 @@ exports["file structure checks that the file content carries over 1"] = ` -helloWorld +# helloWorld Instructions are provided in [googleapis/repo-automation-bots](https://github.com/googleapis/repo-automation-bots/blob/master/README.md) for deploying and testing your bots. This bot uses nock for mocking requests to GitHub, and snap-shot-it for capturing responses; This allows updates to the API surface to be treated as a visual diff, rather than tediously asserting against each field. -Running tests: +## Running tests: \`npm run test\` -To update snapshots: +## To update snapshots: \`npm run test:snap\` -Contributing +## Contributing + If you have suggestions for how helloWorld could be improved, or want to report a bug, open an issue! We'd love all and any contributions. For more, check out the Contributing Guide. diff --git a/packages/generate-bot/templates/README.md b/packages/generate-bot/templates/README.md index dd67063bbc6..07d7e81e2b1 100644 --- a/packages/generate-bot/templates/README.md +++ b/packages/generate-bot/templates/README.md @@ -1,18 +1,19 @@ -{{programName}} +# {{programName}} Instructions are provided in [googleapis/repo-automation-bots](https://github.com/googleapis/repo-automation-bots/blob/master/README.md) for deploying and testing your bots. This bot uses nock for mocking requests to GitHub, and snap-shot-it for capturing responses; This allows updates to the API surface to be treated as a visual diff, rather than tediously asserting against each field. -Running tests: +## Running tests: `npm run test` -To update snapshots: +## To update snapshots: `npm run test:snap` -Contributing +## Contributing + If you have suggestions for how {{programName}} could be improved, or want to report a bug, open an issue! We'd love all and any contributions. For more, check out the Contributing Guide.