diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index fb9f6619..53b46110 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -3,7 +3,6 @@ Acked adxcrypt AESNI afl -AKIAIOSFODNN Altivec amazonaws amd @@ -122,6 +121,7 @@ img IMO intrinsics ipc +JAVASCRIPT jscpd JTR jtrcrackers diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 241d2635..541e51ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,11 +65,14 @@ However, there are some cases where the rule must be overcome by common sense. ## Create a suitable PR -- Run the `pre-commit run --all-files` command. -- Format all edited or new shell scripts using shfmt. -- Fix all issues detected by markdownlint Visual Studio Code extension (davidanson.vscode-markdownlint). -- Format all edited YAML or Markdown files using "Prettier (esbenp.prettier-vscode). -- Verify to see if PR checks have passed, or if there are any new or attention-worthy warning; +- Use the linter to check for issues and correct them: + +```bash +docker run --rm -e DEFAULT_BRANCH=main -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true \ + -e FIX_JSON_PRETTIER=true -e FIX_MARKDOWN_PRETTIER=true -e FIX_JAVASCRIPT_PRETTIER=true \ + -v $(pwd):/tmp/lint ghcr.io/super-linter/super-linter:v7.2.0 # Update the version +``` + - Update checksums using the command: ```bash @@ -77,6 +80,8 @@ cd scripts && sha256sum ./*.sh > ../requirements.hash && cd - && \ cd patches && sha256sum ./* >> ../requirements.hash && cd - ``` +- Submit your change and then check if the PR checks have passed, or if there are any new or attention-worthy warnings. + ## The PR review process After you open a pull request, you as the author are responsible for resolving: