docs: add shellcheck guidance to CONTRIBUTING.md#160
Conversation
Add "Shell Script Quality" section documenting: - How to run shellcheck on plugin scripts - How to handle intentional patterns with disable directives - Common issues table (SC2086, SC2046, SC2034, SC2155) This provides guidance for contributors on shell script standards. Fixes #155 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Claude finished @sjnims's task in 1m 10s —— View job PR Review: Add shellcheck guidance to CONTRIBUTING.mdSummary✅ Looks good - This is a solid documentation improvement that fills an important gap in contributor guidance. What's Good
Technical AccuracyI verified the following:
Checklist VerificationFrom the PR description:
Minor ObservationsThe only thing I'd note (not a blocker) is that contributors might also benefit from knowing about Recommendation: Approve and merge. This PR effectively documents shellcheck requirements and provides clear, actionable guidance for contributors. |
Description
Add "Shell Script Quality" section to CONTRIBUTING.md documenting shellcheck requirements and best practices for contributors.
Type of Change
Component(s) Affected
Motivation and Context
The plugin contains numerous shell scripts but there was no documented guidance for contributors on:
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:
# shellcheck disable=SCXXXXdirectives for intentional patternsChanges
CONTRIBUTING.md: Added new "Shell Script Quality" sectionTesting
🤖 Generated with Claude Code