Skip to content

docs: add comprehensive developer setup guide #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add comprehensive developer setup guide #286

wants to merge 2 commits into from

Conversation

mecampbellsoup
Copy link
Contributor

Summary

  • Enhanced CONTRIBUTING.md with detailed developer setup instructions, testing guidelines, and troubleshooting
  • Added DEVELOPMENT.md as a quick-start guide for experienced developers
  • Includes platform-specific commands, common development tasks, and structured workflow guidance

Changes Made

  • CONTRIBUTING.md: Expanded from basic legal requirements to comprehensive developer guide with:

    • Detailed setup instructions for all supported Python versions
    • Platform-specific commands (macOS/Linux/Windows)
    • Testing workflows and debugging guidance
    • Code quality tools documentation
    • Project architecture explanation
    • Troubleshooting section with common issues

  • DEVELOPMENT.md: New quick-start guide featuring:

    • TL;DR setup commands for experienced developers
    • Key commands reference
    • Project structure overview
    • Quick debugging tips
    • Essential workflow steps

Test Plan

  • Validated all setup commands work correctly in virtual environment
  • Verified documentation commands match CI configuration
  • Confirmed all referenced files and paths exist
  • Pre-commit hooks pass successfully

Benefits

  • Reduces onboarding time for new contributors
  • Provides clear guidance for both novice and experienced developers
  • Includes troubleshooting for common development issues
  • Documents project structure and conventions
  • Makes the project more accessible to the open source community

🤖 Generated with Claude Code

@mecampbellsoup
docs: add comprehensive developer setup guide
3a90ca4 
- Enhance CONTRIBUTING.md with detailed setup instructions, testing guidelines, and troubleshooting
- Add DEVELOPMENT.md as quick-start guide for experienced developers
- Include platform-specific commands and common development tasks
- Provide structured workflow guidance for contributors
@mecampbellsoup
docs: enhance test suite documentation with coverage and artifacts
400cfc5 
- Add coverage command to DEVELOPMENT.md quick reference
- Include test artifact generation options for debugging (screenshots, videos, traces)
- Provide complete testing command reference for developers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mecampbellsoup