Skip to content

Add guidance for commenting auxiliary code changes in usethis-python-code-modify skill#1517

Merged
nathanjmcdougall merged 2 commits into
mainfrom
copilot/adjust-agent-skills-comments
Mar 25, 2026
Merged

Add guidance for commenting auxiliary code changes in usethis-python-code-modify skill#1517
nathanjmcdougall merged 2 commits into
mainfrom
copilot/adjust-agent-skills-comments

Conversation

Copilot AI commented Mar 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

When agents fix pre-existing/latent issues encountered while working on an unrelated task, reviewers lack context for why those peripheral changes were included. Agents should document such auxiliary changes with inline code comments.

  • Added "Document auxiliary changes with comments" section to usethis-python-code-modify skill
  • Bumped skill version 1.1 → 1.2
Original prompt

This section details on the original issue you should resolve

<issue_title>Adjust agent skills to encourage the use of comments when making auxillary changes</issue_title>
<issue_description>In #1510, the agent was working on a feature, but it realized that the test was failing due to a rather peripheral issue, unrelated to the main change.

In particular, it realized that there was a bracket notation [] that came up in a message, and it needed to add markup=False to console pretty-printing to prevent this being interpreted as a special markup syntax.

When I came to review the PR, I didn't have that context. The general principle is that auxillary changes that aren't directly related to the current task but are "pre-existing"/latent should almost always be documented with a code comment explaining the context for the decision.

We should update our usethis-python-code-modify skill accordingly. </issue_description>

Comments on the Issue (you are @copilot in this section)

📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

@nathanjmcdougall
Update usethis-python-code-modify skill to encourage comments on auxi…
17407d9 
…liary changes

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/4198eba0-3fd7-41fc-8a20-94cf78150bf9
Copilot AI changed the title [WIP] Update agent skills to encourage comments for auxiliary changes Add guidance for commenting auxiliary code changes in usethis-python-code-modify skill Mar 25, 2026
Copilot AI requested a review from nathanjmcdougall March 25, 2026 02:37
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review March 25, 2026 02:45
@nathanjmcdougall nathanjmcdougall merged commit 5056e6e into main Mar 25, 2026
@nathanjmcdougall nathanjmcdougall deleted the copilot/adjust-agent-skills-comments branch March 25, 2026 02:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@nathanjmcdougall nathanjmcdougall nathanjmcdougall approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@nathanjmcdougall nathanjmcdougall

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Adjust agent skills to encourage the use of comments when making auxillary changes

2 participants

@nathanjmcdougall