Skip to content

[plan] Add gosec rule documentation links to specs/gosec.md #12184

@github-actions

Description

@github-actions

Objective

Enhance specs/gosec.md with direct links to gosec rule documentation for each excluded rule.

Context

From discussion #12003: Make it easier for developers to understand security rules by adding documentation links for each excluded rule.

Approach

  1. Review current exclusions in specs/gosec.md
  2. Add documentation links for each rule:
### G101: Hardcoded Credentials
**CWE-798**: Use of Hard-coded Credentials  
**Documentation**: [gosec rule G101](https://github.com/securego/gosec#available-rules)  
**Why Excluded**: False positives in test fixtures and example code
  1. Add link to gosec rules reference at top of document
  2. Include examples from codebase where applicable

Files to Modify

  • Update: specs/gosec.md

Acceptance Criteria

  • All excluded rules have documentation links
  • Links are valid and point to correct rule docs
  • General gosec documentation link added at top
  • Examples provided for context

Priority

LOW - Documentation improvement

Estimated Effort

30-45 minutes

AI generated by Plan Command for discussion #12003

Metadata

Metadata

Labels

ai-generatedcookieIssue Monster Loves Cookies!documentationImprovements or additions to documentationplan

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions