Skip to content

Commit 765a87c

Browse files
authored
refactor: update CONTRIBUTING.md (#2582)
Co-authored-by: Oli Morris <[email protected]>
1 parent 0ed06a6 commit 765a87c

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,33 @@ Before contributing a PR, please open up a discussion to talk about it. While I
88

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

11+
### Plugin Philosophy
12+
13+
**CodeCompanion enables developers to write better code, faster, through LLM interactions.**
14+
15+
When proposing new features, please ensure they align with this philosophy:
16+
17+
**In Scope:**
18+
- LLM interaction modes (chat, inline, cmd, workflows, agents)
19+
- Tools and context that extend LLM capabilities while coding
20+
- Integrations (MCP, adapters) that enhance LLM assistance
21+
- Essential infrastructure for reviewing and applying LLM-generated changes (diff providers, edit tracking, completion/action providers)
22+
23+
**Out of Scope:**
24+
- Elaborate UIs (beyond basic diff/review needs) or features that do not facilitate LLM-assisted code generation
25+
- Features better served by standalone plugins
26+
- General development tools not tied to LLM interactions
27+
28+
**Questions to ask:**
29+
1. Does this help the LLM write code?
30+
2. Is this essential for users to accept/reject LLM code?
31+
3. Or is this nice-to-have feature that belongs in a separate plugin?
32+
4. To add this feature, are we looking at > 1,000 LOC of new code?
33+
34+
**If a feature is primarily about viewing what's already happened rather than enabling the next LLM interaction, it's out of scope.**
35+
36+
If your feature doesn't directly support LLM-assisted code generation or isn't minimal essential infrastructure, consider publishing it as a standalone plugin that works alongside CodeCompanion.
37+
1138
## How to Contribute
1239

1340
1. Open up a [discussion](https://github.com/olimorris/codecompanion.nvim/discussions) to propose your idea.

0 commit comments

Comments
 (0)