Commit 444ed21
docs: add shellcheck guidance to CONTRIBUTING.md (#160)
## Description
Add "Shell Script Quality" section to CONTRIBUTING.md documenting
shellcheck requirements and best practices for contributors.
## Type of Change
- [x] Documentation update (improvements to README, CLAUDE.md, or
component docs)
## Component(s) Affected
- [x] Documentation (README.md, CLAUDE.md, SECURITY.md)
## Motivation and Context
The plugin contains numerous shell scripts but there was no documented
guidance for contributors on:
- Running shellcheck before submitting PRs
- Expected shellcheck compliance level
- How to handle intentional patterns that trigger warnings
CLAUDE.md mentions shellcheck in the Linting section, but
CONTRIBUTING.md didn't reference this or explain expectations.
Fixes #155
## Solution
Added "Shell Script Quality" subsection under Development Guidelines
with:
- Commands to run shellcheck on plugin scripts
- How to add `# shellcheck disable=SCXXXX` directives for intentional
patterns
- Common issues table (SC2086, SC2046, SC2034, SC2155)
## Changes
- `CONTRIBUTING.md`: Added new "Shell Script Quality" section
## Testing
- [x] Linting passes (markdownlint)
---
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude <noreply@anthropic.com>1 parent 873a6ce commit 444ed21
1 file changed
Lines changed: 32 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
167 | 167 | | |
168 | 168 | | |
169 | 169 | | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
170 | 202 | | |
171 | 203 | | |
172 | 204 | | |
| |||
0 commit comments