Skip to content

Commit

Permalink
Add npm script "ci", update CONTRIBUTING.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidAnson committed Nov 24, 2023
1 parent cab3024 commit 92db2a2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ Package versions for `dependencies` and `devDependencies` should be specified ex
The short explanation is that doing otherwise eventually leads to inconsistent behavior and broken functionality.
(See [Pin your npm/yarn dependencies][pin-dependencies] for a longer explanation.)

Run tests before sending a pull request via `npm test` in the [usual manner][npm-scripts].
Tests should all pass on all platforms.
Run basic tests via `npm test`.
Run UI tests via `npm run test-ui`.
Lint by running `npm run lint`.

Pull requests should contain a single commit.
Pull requests should contain a single commit that addresses a single issue.
If necessary, squash multiple commits before creating the pull request and when making changes.
(See [Git Tools - Rewriting History][rewriting-history] for details.)

Expand All @@ -38,7 +39,6 @@ Thank you!

[closing-keywords]: https://help.github.com/articles/closing-issues-using-keywords/
[issues]: https://github.com/DavidAnson/vscode-markdownlint/issues
[npm-scripts]: https://docs.npmjs.com/misc/scripts
[pin-dependencies]: https://maxleiter.com/blog/pin-dependencies
[rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
},
"funding": "https://github.com/sponsors/DavidAnson",
"scripts": {
"ci": "npm test && npm run test-ui",
"compile": "webpack --mode production",
"compile-debug": "webpack --mode none",
"docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm install",
Expand Down

0 comments on commit 92db2a2

Please sign in to comment.