chore: add resources to provide guidance to coding agents #4725
Conversation
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
simonswine
approved these changes
Jan 5, 2026
Contributor
simonswine
left a comment
simonswine
left a comment
There was a problem hiding this comment.
Happy to give it a try
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Adds CLAUDE.md and Cursor Rules to guide coding agents on best practices, things to avoid, etc.
I used Claude Code to create a foundation for CLAUDE.md using the existing contribution guide and then made it better. The Cursor Rules are derived from CLAUDE.md.
I've verified that the instructions work in both Claude Code and Cursor by asking questions like What are the main components in Pyroscope's write path?. I haven't tried generating code and seeing how well best practices are followed.
This is open for debate and contributions. Feel free to suggest changes, add support for other agents or raise your concerns if you have any.