Skip to content

docs: require workaround comments in AGENTS#274

Merged
kdy1 merged 1 commit intomainfrom
kdy1/docs-workaround-comment-rule
Mar 17, 2026
Merged

docs: require workaround comments in AGENTS#274
kdy1 merged 1 commit intomainfrom
kdy1/docs-workaround-comment-rule

Conversation

@kdy1
Copy link
Copy Markdown
Contributor

@kdy1 kdy1 commented Mar 17, 2026

Summary

  • add a repository-wide rule to document workaround context in code comments
  • require comments to explain why the workaround exists, its scope, and removal conditions

Testing

  • not run (docs-only change)

@kdy1 kdy1 merged commit 5870bb7 into main Mar 17, 2026
14 checks passed
@kdy1 kdy1 deleted the kdy1/docs-workaround-comment-rule branch March 17, 2026 04:15
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.

1 participant