Skip to content

Comments

Add CLAUDE.md development guide for AI assistants#586

Merged
laughingman7743 merged 1 commit intomasterfrom
add-claude-md
Jul 19, 2025
Merged

Add CLAUDE.md development guide for AI assistants#586
laughingman7743 merged 1 commit intomasterfrom
add-claude-md

Conversation

@laughingman7743
Copy link
Member

@laughingman7743 laughingman7743 commented Jul 19, 2025

Summary

  • Added comprehensive CLAUDE.md file to guide AI assistants working on the PyAthena project
  • Includes project overview, development guidelines, and best practices
  • Uses make commands for all development tasks (lint, test, format)

Description

This PR adds a CLAUDE.md file that serves as a development guide for AI assistants. The guide includes:

  • Project overview and architectural principles
  • DB API 2.0 compliance requirements
  • Development workflow using make commands
  • Testing and debugging guidelines
  • Security and performance best practices
  • Common pitfalls to avoid
  • Project structure conventions

The guide ensures AI assistants can effectively contribute to the project while maintaining code quality and following established patterns.

Test plan

  • Verified all make commands referenced in the guide exist in Makefile
  • Review by maintainers for accuracy and completeness

🤖 Generated with Claude Code

@laughingman7743 laughingman7743 marked this pull request as ready for review July 19, 2025 01:37
This guide provides comprehensive information for AI assistants working on the PyAthena project, including:
- Project overview and architectural principles
- Development guidelines with make commands
- Testing requirements and debugging tips
- Security and performance best practices
- Common pitfalls to avoid

Version and Python support references point to source files to avoid maintenance overhead.

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

Co-Authored-By: Claude <noreply@anthropic.com>
@laughingman7743 laughingman7743 merged commit 7feea83 into master Jul 19, 2025
5 checks passed
@laughingman7743 laughingman7743 deleted the add-claude-md branch July 19, 2025 02:01
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.

1 participant