Skip to content

Add CLAUDE.md with development setup instructions#10692

Merged
max-sixty merged 1 commit into
pydata:mainfrom
max-sixty:claude
Sep 3, 2025
Merged

Add CLAUDE.md with development setup instructions#10692
max-sixty merged 1 commit into
pydata:mainfrom
max-sixty:claude

Conversation

@max-sixty
Copy link
Copy Markdown
Collaborator

Summary

  • Add CLAUDE.md file with essential development commands for xarray
  • Includes setup with uv sync, test commands, and linting instructions

Test plan

  • uv sync runs successfully
  • uv run pytest xarray -n auto executes tests
  • pre-commit run --all-files runs linting checks
  • uv run dmypy run performs type checking

🤖 Generated with Claude Code

Simple development instructions for using uv with xarray, including
commands for running tests and linting.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@max-sixty
Copy link
Copy Markdown
Collaborator Author

are folks OK with this?

two decisions:

  • is it OK to have Claude Code specific files with instructions?
  • is it OK to suggest to the agents that it use uv

I'd like to merge this...
...but reasonable options from here:

  • have other files like AGENTS.md which are symlinked
  • additionally add miniconda instructions

@max-sixty max-sixty enabled auto-merge (squash) September 3, 2025 23:30
@max-sixty max-sixty merged commit bd2a035 into pydata:main Sep 3, 2025
36 checks passed
@max-sixty max-sixty deleted the claude branch September 3, 2025 23:37
@TomNicholas
Copy link
Copy Markdown
Member

I think these text files represent low risk and low commitment to us, so you (and I know @ianhi is interested) should just iterate how you like.

Running AI agents is always at your own risk, I don't think we could be reasonably blamed for writing something sensible but opinionated in a text file in our repo.

I would pause only before changes to actual user-facing docs - those should be human-prioritizing.

@max-sixty
Copy link
Copy Markdown
Collaborator Author

yes, tbc, folks are definitely responsible for anything that's merged from them, whether they typed the words or an AI agent did!

I also hold a norm that we should all be transparent when an AI agent does work — both in code or comments — we shouldn't have AIs impersonating us. it's fine to say "it's the AI's words. I stand behind them and take responsibility for them but an AI wrote them"

@TomNicholas
Copy link
Copy Markdown
Member

Agree - might want to add something like that to contributor's guidelines and PR template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants