Watermelon
? Pull Requests With Business Value
Collaboration
Watermelon for Visual Studio Code
Watermelon is a Passive Documentation Search Engine serving both our GitHub app and IDE extension. Our set of plug-ins help developers understand code context, improve their coding velocity and merge PRs like a breeze.
We've built a search algorithm that indexes the most relevant passive documentation for a given block of code.
To obtain business context in your IDE, use this extension.
To obtain business context in your CI/CD, take a look at our GitHub Application
Integrations
We currently support the following integrations
| Watermelon Product | Git | Project Management | Messaging | Documentation |
|---|---|---|---|---|
| VS Code | GitHub, GitLab (Beta), Bitbucket (Beta) | Jira | Slack | |
| GitHub App | GitHub. | Jira, Linear | Slack | Notion, Confluence |
Features
Watermelon's VS Code extension allows you to obtain business context for a file or block of code via:
- Hover to get context
- Get code context button (to obtain the complete context)
Requirements
- macOS 10.11+, Windows 10+ or Linux
- Visual Studio Code v1.63.0+
- Visual Studio Code Insiders v1.63.0+
- VS Codium v1.63.0+ (BETA INTEGRATION)
- You must have Git locally installed (try
git --versionor install it now)
Installation
Download from the VS Code Marketplace.
Alternatively, you can search for "Watermelon" in VS Code's built-in extension marketplace and install from there.
Download from the VS Codium Marketplace (Open VSX Registry)
Commands
Watermelon comes with a few commands that you can run from VS Code's Command Palette. The result is exactly the same as running a Watermelon query with the green button. Results sit in your sidebar.
| Command | Description |
|---|---|
watermelon.start | Get the historical context of the selected block of code |
watermelon.show | Reveal the extension |
watermelon.recommend | Add the extension to the list of recommended |
Shortcuts
As an alternative, you can use the following shortcuts:
Ctrl+Shift+C(Cmd+Shift+Con Mac) to view your context results
Contributing
Check out Contributing.md and be aware of the Code of Conduct!
We're an early-stage project, therefore we still have the luxury to coordinate via short chats with our contributors. If you're interested in contributing, please join our Discord community. Alternatively, comment on our issues if you plan to solve one.
Analytics
We use VS Code's telemetry library. The library respects the user's decision about whether or not to send telemetry data.
We also have settings to disable it.
Watermelon doesn't store your code
Supporters
About Watermelon
Watermelon is built by a globally distributed team of developers devoted to making software development easier. Join our Discord community, follow us on Twitter and go to the Watermelon blog to get the best programming tips.