This diff updates the CONTRIBUTING.md to give more info on how to
setup shellcheck from the precompiled binaries, and check the correct
version is in the PATH.
Depends on D7074.
Details
Details
- Reviewers
jasonbcox - Group Reviewers
Restricted Project - Commits
- rABCa02d9fce3d58: [DOC] Improve instructions for setting up shellcheck
Read the doc and try the instructions.
Diff Detail
Diff Detail
- Repository
- rABC Bitcoin ABC
- Branch
- doc_shellcheck_path
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 12235 Build 24683: Default Diff Build & Tests build-diff Build 24682: Build without Wallet build-without-wallet Build 24681: Build with clang-10 build-clang-10 Build 24680: arc lint + arc unit
Event Timeline
Comment Actions
This doesn't strike me as something that belongs in CONTRIBUTING and brings up lots of questions:
- Why do we expect new devs to have multiple shellcheck versions installed?
- Why do we expect shellcheck to not be in PATH correctly?
- What makes shellcheck install special such that we need to tell devs to check the version, but we do not do this for other tools?
Comment Actions
This is expected to give a hint on why arcanist could fail to use a recent shellcheck version freshly downloaded.
Talked offline, this will be simplified a bit to not require more steps for the user.