Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md best practices #640

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Update CONTRIBUTING.md best practices #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/spelling/expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Acked
adxcrypt
AESNI
afl
AKIAIOSFODNN
Altivec
amazonaws
amd
Expand Down Expand Up @@ -122,6 +121,7 @@ img
IMO
intrinsics
ipc
JAVASCRIPT
jscpd
JTR
jtrcrackers
Expand Down
15 changes: 10 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,23 @@ 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
```

- Update checksums using the command:

```bash
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:
Expand Down