Update contributing documentation for agents - #21776
Merged
Merged
Conversation
dwelch-r7
force-pushed
the
update-frozen-string-guidance
branch
3 times, most recently
from
August 11, 2026 22:01
b555c14 to
4098710
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies frozen-string guidance for library, module, and spec files without changing runtime behavior.
Changes:
- Scopes the pragma requirement to new library files.
- Removes it from module templates and guidance.
- Documents mutable-string handling with
String.new.
Impact Analysis: isolated change; no meaningful downstream impact identified from diff.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
AGENTS.md |
Clarifies frozen-string conventions and updates templates. |
CONTRIBUTING.md |
Removes the module pragma requirement. |
.github/instructions/modules.instructions.md |
Updates module structure guidance. |
.github/instructions/library.instructions.md |
Clarifies library mutable-string guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
14
to
17
| 6. `prepend Msf::Exploit::Remote::AutoCheck` — ALWAYS LAST | ||
| 8. `def initialize` with `update_info` | ||
| 9. `def check` (when possible) | ||
| 10. `def exploit` or `def run` |
bwatters-r7
reviewed
Aug 11, 2026
| 4. Protocol mixins (`include Msf::Exploit::Remote::HttpClient`, etc.) | ||
| 5. Utility mixins (`include Msf::Exploit::FileDropper`, etc.) | ||
| 6. `prepend Msf::Exploit::Remote::AutoCheck` — ALWAYS LAST | ||
| 8. `def initialize` with `update_info` |
Contributor
Author
There was a problem hiding this comment.
it's been banned because of the whole 6 7 meme
(I'll put it back)
…iteral guidance for new library files
dwelch-r7
force-pushed
the
update-frozen-string-guidance
branch
from
August 11, 2026 22:08
4098710 to
844110f
Compare
bwatters-r7
approved these changes
Aug 11, 2026
adfoster-r7
approved these changes
Aug 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Clarifies
# frozen_string_literal: trueguidance in AGENTS.md. The previous wording ("add to new files") was overly broad and caused confusion on PR #21574, where a spec file with the pragma crashed against library code that mutates string instance variables.The new guidance explicitly scopes where frozen string literals should and shouldn't be used:
lib/): yes, withString.newor+''for mutable buffersRelated Issue: Discussion on #21574
Breaking Changes
None — documentation only.
Verification Steps
Style/FrozenStringLiteralComment: Enabled: falseconfigurationString.newis listed first (177 files inlib/use it vs 46 using+'')Test Evidence
N/A — documentation change only.
Environment
AI Usage Disclosure
AI (Kiro/Claude) was used to draft the revised wording based on analysis of existing codebase patterns and the failure observed on PR #21574.
Pre-Submission Checklist