-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(CONTRIBUTING.md): update best practices (#640)
Change notes on the intended formatting. Signed-off-by: Claudio André <[email protected]>
- Loading branch information
1 parent
7cb1acf
commit 8622e4a
Showing
1 changed file
with
10 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 \ | ||
Check failure Code scanning / check-spelling Unrecognized Spelling Error
JAVASCRIPT is not a recognized word. (unrecognized-spelling)
|
||
-v $(pwd):/tmp/lint ghcr.io/super-linter/super-linter:v7.2.0 # Update the version | ||
``` | ||
|
||
- 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: | ||
|