Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (48 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 2.14 KB

Contributing to Career-Ops

Thanks for your interest in contributing! Career-Ops is built with Claude Code, and you can use it for development too.

Before Submitting a PR

Please open an issue first to discuss the change you'd like to make. This helps us align on direction before you invest time coding.

PRs without a corresponding issue may be closed if they don't align with the project's architecture or goals.

What makes a good PR

  • Fixes a bug listed in Issues
  • Addresses a feature request that was discussed and approved
  • Includes a clear description of what changed and why
  • Follows the existing code style and project philosophy (simple, minimal, quality over quantity)

Quick Start

  1. Open an issue to discuss your idea
  2. Fork the repo
  3. Create a branch (git checkout -b feature/my-feature)
  4. Make your changes
  5. Test with a fresh clone (see docs/SETUP.md)
  6. Commit and push
  7. Open a Pull Request referencing the issue

What to Contribute

Good first contributions:

  • Add companies to templates/portals.example.yml
  • Translate modes to other languages
  • Improve documentation
  • Add example CVs for different roles (in examples/)
  • Report bugs via Issues

Bigger contributions:

  • New evaluation dimensions or scoring logic
  • Dashboard TUI features (in dashboard/)
  • New skill modes (in modes/)
  • Script improvements (.mjs utilities)

Guidelines

  • Keep modes language-agnostic when possible (Claude handles both EN and ES)
  • Scripts should handle missing files gracefully (check existsSync before readFileSync)
  • Dashboard changes require go build — test with real data before submitting
  • Don't commit personal data (cv.md, profile.yml, applications.md, reports/)

Development

# Scripts
node verify-pipeline.mjs     # Health check
node cv-sync-check.mjs        # Config check

# Dashboard
cd dashboard && go build -o career-dashboard .
./career-dashboard --path .

Need Help?