Skip to content

Conversation

@skyvanguard
Copy link

Summary

  • Add comprehensive README.md documentation for the security-guidance plugin
  • This was the only plugin in the plugins/ directory without a README.md file

Changes

The README includes:

  • Overview of the plugin's purpose and key features
  • Documentation of all 9 security patterns detected (GitHub Actions injection, command injection, XSS vulnerabilities, etc.)
  • Remediation guidance for each vulnerability type with safe alternatives
  • Configuration options (environment variable to disable)
  • State management explanation
  • Troubleshooting guide
  • Technical details about hook configuration and exit codes
  • Contributing guide for adding new patterns

Test plan

  • Verified README follows the same format as other plugin READMEs
  • Verified all 9 security patterns from security_reminder_hook.py are documented
  • Verified remediation guidance matches the code comments

🤖 Generated with Claude Code

Add comprehensive documentation for the security-guidance plugin, which
was the only plugin in the repository without a README.md file.

The README includes:
- Overview of the plugin's purpose and features
- Documentation of all 9 security patterns detected
- Remediation guidance for each vulnerability type
- Configuration options and environment variables
- Troubleshooting guide
- Technical details about hook configuration

Co-Authored-By: Claude Opus 4.5 <[email protected]>

**Manual testing:**
```bash
cc --plugin-dir /path/to/security-guidance
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
cc --plugin-dir /path/to/security-guidance
claude --plugin-dir /path/to/security-guidance

}
```

## License
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you delete the "License" section?

- Change 'cc' to 'claude' command in manual testing example
- Remove License section as requested

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@skyvanguard
Copy link
Author

@ddworken I've addressed your feedback in commit 3e79d32:

  • Changed cc to claude in the installation command
  • Removed the License section

Ready for re-review when you have a chance. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants