Skip to content

docs: add CLAUDE.md for Claude Code guidance - #63

Merged
albertotb merged 1 commit into
mainfrom
add-claude-md
Jan 26, 2026
Merged

docs: add CLAUDE.md for Claude Code guidance#63
albertotb merged 1 commit into
mainfrom
add-claude-md

Conversation

@albertotb

@albertotb albertotb commented Jan 13, 2026

Copy link
Copy Markdown
Member

Summary

  • Add CLAUDE.md documentation file for Claude Code instances
  • Includes common commands (test, lint, build), architecture overview, and code style conventions
  • Helps future Claude Code sessions be productive more quickly

En principio este repo debería de quedar obsoleto por el template de copier, pero como aun estamos usando este bastante lo he actualizado en ambos

Test plan

  • Verify CLAUDE.md is properly formatted markdown
  • Verify commands listed are accurate per Makefile and pyproject.toml

🤖 Generated with Claude Code

Add documentation file to help Claude Code instances understand
the repository structure, common commands, and code style conventions.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@albertotb

albertotb commented Jan 13, 2026

Copy link
Copy Markdown
Member Author

No se si puede ser interesante añadir algo sobre estilo de PRs y/o commits

Comment thread CLAUDE.md

## Architecture

- `/template`: Main Python package

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

La duda que tengo, es parecida a la que puse en el otro repo.
En este CLAUDE.md hay cosas que deben permanecer en el CLAUDE.md de proyecto instanciado (como lo de docstrings estilo numpy); pero hay otras que deben ser cambiadas (como este /template). No se si hay forma de indicar esto o algo así

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

En este no, en el otro si. Este CLAUDE.md se copia integramente al proyecto resultante (es la ventaja de Copier). En teoría todo lo que hay aquí debería ser del proyecto, no instrucciones para el template. Si hay algo que sea para el template habria que borrarlo

@albertotb
albertotb requested a review from vicgalle January 16, 2026 12:55
@albertotb
albertotb merged commit 8696540 into main Jan 26, 2026
6 checks passed
@albertotb
albertotb deleted the add-claude-md branch January 26, 2026 12:53
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