Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.7 KB
Raw

Contributing to CodeCompanion.nvim

Thank you for considering a contribution to this project!

Before contributing a PR, please open up a discussion to talk about it further. Whilst I welcome contributions that improve the plugin, I want to refrain from adding features that will add little value and a lot of bloat as the plugin is already c. 9,000 LOC.

The plugin has recently adopted semantic versioning. As such, any PR which breaks the existing API is unlikely to merged.

How to Contribute

  1. Open up a discussion.
  2. Fork the repository and create your branch from main.
  3. Add your feature or fix to your branch.
  4. Ensure your code follows the project's coding style and conventions.
  5. Make sure your code has adequate test coverage and is well-documented.
  6. Open a pull request (PR) with a clear title and description.

Guidelines

  • Feature Requests: I encourage you to suggest new features! However, please note that I will only add features that align with my personal workflow. But feel free to open up a discussion with a view to a PR.
  • Bug Fixes: If you're submitting a PR to address a bug, please ensure you've raised this as an issue that can be recreated and tested.
  • Responsibility: If you add a feature, you are responsible for maintaining and bug fixing that feature going forward. The maintainers may provide guidance and support, but ultimate responsibility lies with the contributor.
  • Code Quality: I strive to maintain high code quality. Please ensure that your PR has corresponding tests.
  • Communication: If you have any questions or need clarification, feel free to open an issue or reach out to the maintainers.