Contributing to NextCV⚓︎

First off, thank you for considering contributing to NextCV! We welcome all contributions, from bug fixes to new features and documentation improvements.

🚀 How to Contribute⚓︎

We use uv as our package manager - it's like pip, but much faster! Learn more in the uv documentation.

We recommend following this workflow to contribute:

1. Fork the repository: Create your own copy of the project.
2. Create a feature branch: git checkout -b my-new-feature

3. Install Python tools:

   # Install uv (if you don't have it)
   curl -LsSf https://astral.sh/uv/install.sh | sh
   

4. Install C++ tools:

   macOSUbuntu/Debian

   brew install clang-format llvm
   # Add LLVM to PATH (add to ~/.zshrc or ~/.bash_profile)
   echo 'export PATH="/usr/local/opt/llvm/bin:$PATH"' >> ~/.zshrc
   

   sudo apt-get install clang-format clang-tidy
   

5. Set up the development environment:

   # Install dependencies with uv (blazing fast Python package manager)
   uv sync
   
   # Install pre-commit hooks
   uvx pre-commit install
   

6. Make your changes: Write your code and add tests for it.

7. Run tests and code quality checks:

   # Run tests
   uv run pytest
   
   # Run pre-commit checks
   uvx pre-commit run --all-files
   

8. Commit your changes: git commit -m 'Add some feature'

9. Push to your branch: git push origin my-new-feature
10. Submit a pull request: Open a pull request from your fork to the main NextCV repository.

💡 What to Contribute⚓︎

Not sure where to start? Here are a few ideas:

- **🐛 Bug fixes:** Look for open issues with the `bug` label.
- **✨ New features:** Propose a new feature by opening an issue to discuss it first.
- **📚 Documentation:** Improve the documentation, add examples, or write tutorials.
- **⚡️ Performance improvements:** Find bottlenecks and optimize them.