Skip to content

Conversation

@okotaku
Copy link
Owner

@okotaku okotaku commented Jul 7, 2025

Summary

  • Remove CONTRIBUTING.md as development is AI-first with human review
  • Integrate comprehensive development guidelines into CLAUDE.md
  • Establish CLAUDE.md as the single source of truth for development practices

Changes Made

🗑️ Removed CONTRIBUTING.md

  • Deleted human-oriented contribution guide as development is now AI-first
  • Claude Code handles primary development with human guidance and review

📝 Enhanced CLAUDE.md

Development Philosophy Section

  • Define AI-first development approach
  • Claude Code performs primary development (code generation, bug fixes, features, refactoring)
  • Humans provide guidance and review (requirements, strategic direction, quality assurance)
  • Quality gates ensure reliability through automated testing, linting, and type checking

Project Standards Integration

  • Code Quality Requirements: All quality gates that must pass
  • Commit Standards: Conventional commit format requirements
  • Development Workflow: 5-step process from requirements to integration
  • Code Patterns: Established patterns to follow (Python 3.12+, type hints, docstrings, etc.)
  • Project Structure Guidelines: Clean organization principles

🔄 Updated README.md

  • Changed Contributing section to reference CLAUDE.md instead of CONTRIBUTING.md
  • Emphasize AI-first development approach
  • Direct developers to CLAUDE.md for comprehensive guidelines

Benefits

Single Source of Truth: All development guidelines consolidated in CLAUDE.md
AI-First Alignment: Documentation matches the actual development workflow
Simplified Structure: Removes redundant human-oriented contribution guide
Enhanced AI Context: Claude Code has comprehensive project context in one place
Clear Workflow: Well-defined process for AI development with human oversight

New Development Workflow

  1. Requirements Gathering: Human provides clear requirements and context
  2. AI Implementation: Claude Code generates code following project patterns
  3. Quality Verification: Run all quality gates to ensure standards
  4. Human Review: Human reviews changes for correctness and alignment
  5. Integration: Merge changes after successful review

Test Plan

  • Verify CLAUDE.md contains all necessary development guidelines
  • Confirm README.md properly references CLAUDE.md
  • Test that no references to CONTRIBUTING.md remain
  • Validate markdown formatting and linting passes
  • Ensure comprehensive project context is available for AI development

🤖 Generated with Claude Code

- Fix trailing whitespace in CLAUDE.md and README.md
- Apply mdformat formatting to markdown files

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

Co-Authored-By: Claude <noreply@anthropic.com>
@okotaku okotaku merged commit 43a5f83 into main Jul 7, 2025
10 checks passed
@okotaku okotaku deleted the feat/remove-contributing branch July 7, 2025 23:09
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