Skip to content

Comments

feat: Add development tooling and comprehensive setup guide#139

Merged
anchapin merged 1 commit intomainfrom
feature/dev-tooling-improvements
Feb 18, 2026
Merged

feat: Add development tooling and comprehensive setup guide#139
anchapin merged 1 commit intomainfrom
feature/dev-tooling-improvements

Conversation

@anchapin
Copy link
Owner

Overview

Adds comprehensive Makefile and setup documentation for resume-cli development and usage.

What's Added

Makefile - Simplified developer experience:

make install           # Install from source
make install-ai        # Install with AI support (Claude, OpenAI, Gemini)
make install-dev       # Install with development tools

make validate          # Validate resume.yaml schema
make generate          # Generate resume from template
make generate-package  # Generate resume + cover letter package
make ats-check         # Check ATS compatibility
make variants          # List available variants

make test              # Run test suite
make test-coverage     # Run tests with coverage report
make lint              # Check code style
make format            # Auto-format code

make clean             # Clean build artifacts
make check-deps        # Verify dependencies
make check-config      # Validate configuration files

SETUP.md - Complete development and usage guide:

  • System requirements (Python, LaTeX, GitHub CLI)
  • Quick start (4 steps to first resume)
  • Detailed step-by-step installation
  • Configuration walkthrough
  • Verification procedures
  • Development workflow examples
  • Common commands with examples
  • Comprehensive troubleshooting section
  • Advanced usage (custom variants, batch generation)
  • Architecture overview
  • Integration patterns

Benefits

Easy installation: make install instead of manual pip commands
Clear documentation: New users have step-by-step guide
Development tools: Quick access to testing and linting
Examples: Common commands shown with sample usage
Troubleshooting: Covers most common issues and solutions
Advanced patterns: Batch generation, custom templates, CI/CD integration

Usage

First time setup:

make install
cp resume.example.yaml resume.yaml
nano resume.yaml          # Edit with your info
make validate             # Check for errors
make generate             # Generate resume

With AI support:

make install-ai           # Install AI dependencies
# Edit .env with API keys
make generate-package --job-desc job.txt

Development:

make install-dev          # Install dev tools
make test                 # Run tests
make lint                 # Check code style
make format               # Auto-format code

File Changes

  • New: Makefile - 250+ lines of make targets
  • New: SETUP.md - Comprehensive setup and usage guide

Backward Compatibility

✅ All existing commands still work
✅ Makefile targets are optional
✅ No breaking changes

Documentation Improvements

The SETUP.md includes:

  • System requirements checklist
  • Installation methods (base, AI, dev)
  • Configuration guide
  • Verification procedures
  • Development workflow
  • Common command examples
  • Troubleshooting section (30+ scenarios)
  • Advanced usage patterns
  • Integration examples

Testing

  • Makefile targets tested
  • Help text displays correctly
  • Installation commands verified
  • Configuration validation works
  • Dependency checking accurate

Closes #XXX (if applicable)

- Add Makefile with commands for install, validate, generate, test, lint, format
- Add install targets for base, AI support, and development tools
- Add common resume operation commands with examples
- Add ATS check and application tracking commands
- Add SETUP.md with detailed development guide
- Include troubleshooting section for common issues
- Provide advanced usage examples and batch operations
- Simplify developer experience with Makefile targets

Amp-Thread-ID: https://ampcode.com/threads/T-019c71ed-3e30-73ed-bb8b-86736276d6d9
Co-authored-by: Amp <amp@ampcode.com>
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Sorry @anchapin, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@anchapin anchapin merged commit 3cd70c9 into main Feb 18, 2026
16 checks passed
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