Skip to content

Commit 5c99185

Browse files
committed
Add some notes for AI on comment etiquette
1 parent 97b394e commit 5c99185

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ When patchback fails to cherry-pick a PR into an older branch, you need to manua
5757

5858
## Contributing
5959

60-
All docs, code comments, and changelogs are in markdown format, **never** use double ticks. Keep comments and changelogs short and concise. Try to keep changelogs to just one line.
60+
All docs, code comments, and changelogs are in markdown format, **never** use double ticks. Keep comments and changelogs short and concise. Make sure changelogs are on one line and changelogs intended for users center around the user, not the developer.
61+
62+
Do NOT excessively comment the code. Follow these guidelines when writing/editing comments:
63+
64+
- Reserve line comments for noting extra context needed to understand a piece of code.
65+
- Do NOT delete existing comments when rewriting code unless explicitly asked. Instead try to rewrite the comment if it no longer matches the code.
66+
- Do NOT add/leave in the comments traces of the prompt used, change explanation or old code history.
6167

6268
When preparing to commit and create a PR you **must** follow our [PR checklist](https://pulpproject.org/pulpcore/docs/dev/guides/pull-request-walkthrough/) Important to note is the AI attribution requirement in our commit messages. Also, note that our changelog entries are markdown.

0 commit comments

Comments
 (0)