apache / apache/cloudstack

Add pre-commit hook `shellcheck-py` to standardize shell files

Open
#10,976 1 comment 0 reactions 0 assignees View on GitHub
long-term-plan
Dominant language
Java
Stars
3.1k
Forks
1.4k
Avg merge
6d 19h
Merged PRs (30d)
32

Description

https://github.com/shellcheck-py/shellcheck-py

https://www.shellcheck.net/

https://github.com/koalaman/shellcheck

Example `.pre-commit-config.yaml` entry:

```
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.10.0.1
hooks:
- id: shellcheck
```

Example `.shellcheckrc` config file:

```
disable=SC2004,SC2041,SC2155,SC2181
```

Contributor guide

Open the contributing guide

Research direction

Start by locating the repository's .pre-commit-config.yaml and reviewing how existing hooks are organized. Add the shellcheck-py hook using the example revision and id, and determine whether the shown .shellcheckrc settings belong in the repository; done means shell files are covered by the configured hook.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.