Skip to content

docs: clarify workaround comment requirement in AGENTS#11700

Merged
kdy1 merged 1 commit intomainfrom
kdy1/add-workaround-comment-guideline
Mar 17, 2026
Merged

docs: clarify workaround comment requirement in AGENTS#11700
kdy1 merged 1 commit intomainfrom
kdy1/add-workaround-comment-guideline

Conversation

@kdy1
Copy link
Copy Markdown
Member

@kdy1 kdy1 commented Mar 17, 2026 •
edited
Loading

Summary

  • add a code style rule in AGENTS.md for workaround changes
  • require sufficient comments to explain why the workaround exists and known limitations

Testing

  • not run (documentation-only change)

@kdy1 kdy1 requested a review from a team as a code owner March 17, 2026 04:15
Copilot AI review requested due to automatic review settings March 17, 2026 04:15
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 17, 2026

⚠️ No Changeset found

Latest commit: 3a0e857

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@kdy1 kdy1 merged commit e2ad6f6 into main Mar 17, 2026
44 checks passed
@kdy1 kdy1 deleted the kdy1/add-workaround-comment-guideline branch March 17, 2026 04:15
@github-actions github-actions Bot added this to the Planned milestone Mar 17, 2026
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 17, 2026

PR Review

Summary: Adds a code style guideline to AGENTS.md requiring sufficient comments when introducing workarounds.

Verdict: LGTM — clean, minimal, and well-placed.

Details

  • Placement: The new bullet fits naturally in the "Code style" section, right after the existing documentation guidelines. Good positioning.
  • Content: The guideline is clear and actionable — it asks for both the why (reason the workaround exists) and known limitations, which is exactly what future readers need.
  • Scope: Single-line, documentation-only change with no risk of breakage.

No issues found. This is a sensible addition that should help maintain codebase clarity, especially for a project of this size where workarounds can easily become mysterious tech debt.

🤖 Generated with Claude Code

Copilot AI reviewed Mar 17, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository’s contributor guidelines to require clearer documentation around workaround code, improving long-term maintainability and reducing “mystery” behavior in the codebase.

Changes:

  • Adds a Code style rule requiring workaround implementations to include comments explaining the rationale and known limitations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 17, 2026

Binary Sizes

File Size
swc.linux-x64-gnu.node 28M (28852296 bytes)

Commit: 798e73e

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Mar 17, 2026

Merging this PR will not alter performance

✅ 219 untouched benchmarks

Comparing kdy1/add-workaround-comment-guideline (3a0e857) with main (a025d2b)

Open in CodSpeed

@github-actions github-actions Bot modified the milestones: Planned, 1.15.21 Mar 22, 2026
@swc-project swc-project locked as resolved and limited conversation to collaborators Apr 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@kodiakhq kodiakhq[bot] kodiakhq[bot] approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

1.15.21

Development

Successfully merging this pull request may close these issues.

2 participants

@kdy1