Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.44 KB
Raw

Contributing to Career-Copilot

Thanks for your interest in contributing! This project works with any AI coding agent (GitHub Copilot CLI, Claude Code, Gemini CLI, Cursor, Windsurf, and more).

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. Run npm run doctor and npm test to verify
  7. Commit and push
  8. Open a Pull Request referencing the issue

What to Contribute

Good first contributions:

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

Bigger contributions:

  • New evaluation dimensions or scoring logic
  • New skill modes (in modes/)
  • Script improvements (.mjs utilities)
  • Adapting modes for different industries or regions

Guidelines

  • Scripts should handle missing files gracefully (check existsSync before readFileSync)
  • Don't commit personal data (cv.md, profile.yml, applications.md, reports/)
  • Use fictional data in examples
  • Test your changes with npm test before submitting

What we do NOT accept

  • PRs that scrape platforms prohibiting automated access (LinkedIn, etc.). We actively reject these to respect third-party ToS.
  • PRs that enable mass-spamming applications to hundreds of roles without evaluation. career-copilot is a quality-over-quantity tool.
  • PRs that add external API dependencies without prior discussion in an issue.
  • PRs containing personal data (real CVs, emails, phone numbers). Use examples/ with fictional data instead.

Development

# Setup validation
npm run doctor

# Health checks
npm run verify
npm run sync-check

# Run all tests
npm test

Need Help?