Contributing to csc.nvim

October 15, 2025 ยท View on GitHub

Thanks for your interest in contributing! PRs and suggestions are welcome.

Reporting Issues

Please include:

  • Neovim version (:version)
  • Minimal config to reproduce the issue
  • Error messages from :CSC status or :messages
  • Your git version (git --version)

Submitting Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes following conventional commits (feat:, fix:, etc.)
  4. Push to your branch
  5. Open a Pull Request

Development Setup

Clone the repo and point your plugin manager to your local copy for testing changes.

Enable debug mode for development:

require('csc').setup({ debug = true })

Code Style

  • Use stylua to format your code according to the .stylua.toml
  • Follow existing patterns in the codebase
  • Keep functions focused
  • Add comments for complex logic

Testing Your Changes

Run the built-in test commands to verify functionality:

  • :CSC status - Test plugin functionality
  • :CSC test_git - Test git integration
  • :CSC analyze - Verify scope parsing
  • Check :messages for debug output

Questions?

Feel free to open an issue for discussion before implementing major changes.

License

By contributing, you agree that your contributions will be licensed under the MIT License.