Skip to content

Dev: add auto-generated CLAUDE.md file#6379

Merged
gmalouf merged 6 commits intoalgorand:masterfrom
onetechnical:claude
Jul 17, 2025
Merged

Dev: add auto-generated CLAUDE.md file#6379
gmalouf merged 6 commits intoalgorand:masterfrom
onetechnical:claude

Conversation

@onetechnical
Copy link
Copy Markdown
Contributor

Summary

If using Anthropic's Claude Code, it can be helpful to have a configuration file that provides details on functions, codebase organization, and style guildelines.

This file is auto-generated by Claude when initializing versus a database.

Test Plan

N/A, this is just a markdown file.

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.47%. Comparing base (94de30f) to head (cb2efac).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6379      +/-   ##
==========================================
- Coverage   50.62%   50.47%   -0.16%     
==========================================
  Files         660      653       -7     
  Lines      110513   110415      -98     
==========================================
- Hits        55952    55732     -220     
- Misses      51704    51819     +115     
- Partials     2857     2864       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cce
Copy link
Copy Markdown
Contributor

cce commented Jul 15, 2025

WDYT of renaming this to AGENTS.md (which I think has a couple of tools using it) and then symlinking CLAUDE.md to this file?

Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated
Co-authored-by: cce <51567+cce@users.noreply.github.com>
@onetechnical
Copy link
Copy Markdown
Contributor Author

WDYT of renaming this to AGENTS.md (which I think has a couple of tools using it) and then symlinking CLAUDE.md to this file?

I like the idea to prevent redundancy, but it also means that you don't have agent-specific instructions per file. Plus, how many agents should we support? Should we also add a GEMINI.md?

We can do what you propose which supports two of them, and leave the rest as an exercise for the reader.

Comment thread AGENTS.md
@onetechnical onetechnical marked this pull request as ready for review July 17, 2025 14:46
@gmalouf gmalouf self-requested a review July 17, 2025 17:50
@gmalouf gmalouf merged commit 36be59f into algorand:master Jul 17, 2025
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants