Skip to content

Commit

Permalink
Update external docs
Browse files Browse the repository at this point in the history
  • Loading branch information
martinpitt committed Dec 12, 2024
1 parent 3f61ea9 commit 2c4217e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions external/source/HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,14 @@ down after the fact — without re-running tests — using something like:

There are also static code and syntax checks which you should run often:

test/static-code
test/common/static-code

It is highly recommended to set up a git pre-push hook, to avoid pushing PRs
that will fail on trivial errors:

ln -s ../../tools/git-hook-pre-push .git/hooks/pre-push

This calls `test/static-code` for each commit you're trying to push.
This calls `test/common/static-code` for each commit you're trying to push.

You can also set up a post-commit hook to do the same, after each commit:

Expand Down Expand Up @@ -258,7 +258,7 @@ The tests require at least `pytest` 7.0.0 or higher to run.
Cockpit uses [ESLint](https://eslint.org/) to automatically check JavaScript
code style in `.js` and `.jsx` files.

The linter is executed as part of `test/static-code`.
The linter is executed as part of `test/common/static-code`.

For developer convenience, the ESLint can be started explicitly by:

Expand All @@ -280,13 +280,13 @@ unused identifiers, and other JavaScript-related issues.
Cockpit uses [Stylelint](https://stylelint.io/) to automatically check CSS code
style in `.css` and `.scss` files.

The linter is executed as part of `test/static-code`.
The linter is executed as part of `test/common/static-code`.

For developer convenience, the Stylelint can be started explicitly by:

npm run stylelint

But note that this only covers files in `pkg/`. `test/static-code` covers
But note that this only covers files in `pkg/`. `test/common/static-code` covers
*all* (S)CSS files tracked in git.

Some rule violations can be automatically fixed by running:
Expand Down

0 comments on commit 2c4217e

Please sign in to comment.