diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e35ebd9..adc2bcc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,7 @@ For example, if your PR passes all tests, you would mark the option as so: Note the 'x' in between the square brackets '[]' --> - [ ] All tests pass -- [ ] I have run `npm run gen-doc` +- [ ] I have run `npm run doc` ### Description diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 343e6c7..ab5b29f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,13 +24,15 @@ Before proceeding any further, read the following documents: Run: ```bash -$ npm run gen-doc +$ npm run doc ``` + ### Running tests Please read `test/README.md` for more information. + ### Transpiling ES2015 for older Node.js versions We use babel to transpile the code: diff --git a/package.json b/package.json index f1924ca..dcd12ad 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,8 @@ "bot" ], "scripts": { - "gen-doc": "jsdoc2md --files src/telegram.js --template doc/api.hbs > doc/api.md", + "gen-doc": "echo 'WARNING: `npm run gen-doc` is deprecated. Use `npm run doc` instead.' && npm run doc", + "doc": "jsdoc2md --files src/telegram.js --template doc/api.hbs > doc/api.md", "build": "babel -d ./lib src", "prepublish": "npm run build && npm run gen-doc", "eslint": "eslint ./src ./test ./examples",