Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

add PR guideline, update CONTRIBUTING.md, move spellcheck #5390

Closed
wants to merge 8 commits into from
Closed

add PR guideline, update CONTRIBUTING.md, move spellcheck #5390

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4ab0202
move cargo-spellcheck related files back to the default pickup path
drahnr Apr 25, 2022
f7303bb
update CONTRIBUTING.md
drahnr Apr 25, 2022
ff4ea87
add PR template
drahnr Apr 25, 2022
e94efb6
lint
drahnr Apr 25, 2022
bdf3752
Update .github/PULL_REQUEST_TEMPLATE.md
drahnr Apr 25, 2022
cea43ed
Update CONTRIBUTING.md
drahnr Apr 26, 2022
0d5b720
add ADR.md
drahnr Apr 26, 2022
d4263fe
make sure these commands are optional
drahnr Apr 26, 2022
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
Next Next commit
move cargo-spellcheck related files back to the default pickup path
  • Loading branch information
@drahnr
drahnr committed Apr 25, 2022
commit 4ab02027068fa214e91446a545f3e4772f6eb8e1
4 changes: 1 addition & 3 deletions .gitlab-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ spellcheck:
- git fetch origin +${CI_DEFAULT_BRANCH}:${CI_DEFAULT_BRANCH}
- echo "___Spellcheck is going to check your diff___"
- cargo spellcheck list-files -vvv $(git diff --diff-filter=AM --name-only $(git merge-base ${CI_COMMIT_SHA} ${CI_DEFAULT_BRANCH} -- :^bridges))
- time cargo spellcheck check -vvv --cfg=scripts/gitlab/spellcheck.toml --checkers hunspell --code 1
- time cargo spellcheck check -vvv --cfg=.spellcheck/spellcheck.toml --checkers hunspell --code 1
Copy link
Contributor

@alvicsam alvicsam Apr 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to move this file to the .spellcheck folder? Recently we unified the structure of CI files in all major repos (https://github.com/paritytech/ci_cd/issues/313) and would like to keep all files in one place.

Copy link
Contributor Author

@drahnr drahnr Apr 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was opposing the change to move them out of there from the get go, since that's the default discovery location of cargo-spellcheck and avoids yet another arg required.

Copy link
Contributor

@TriplEight TriplEight Apr 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arg is not that bad, but what if someone wants several config files for the different crates, dirs, and languages?

Copy link
Contributor

@TriplEight TriplEight Apr 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw you still use the extra arg here

Copy link
Contributor Author

@drahnr drahnr Apr 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I use the extra arg here for explicitness. But for the average user I'd not want that. If the file does not reside in the default lookup dir, the contributor sees an excessive amount of detected errors, that are covered by lingua.dic.

$(git diff --diff-filter=AM --name-only $(git merge-base ${CI_COMMIT_SHA} ${CI_DEFAULT_BRANCH} -- :^bridges))
allow_failure: true

Expand Down Expand Up @@ -854,5 +854,3 @@ cancel-pipeline:
PROJECT_ID: "${CI_PROJECT_ID}"
PIPELINE_ID: "${CI_PIPELINE_ID}"
trigger: "parity/infrastructure/ci_cd/pipeline-stopper"


0 scripts/gitlab/lingua.dic → .spellcheck/lingua.dic
View file
Open in desktop
File renamed without changes.
0 scripts/gitlab/spellcheck.toml → .spellcheck/spellcheck.toml
View file
Open in desktop
File renamed without changes.