Skip to content

Chore/update readme #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
baristaGeek merged 10 commits into from
Jun 21, 2023
Merged

Chore/update readme #539

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9192cdb
Update descriptions, reference GitHub app, and add list of integrations
baristaGeek Jun 13, 2023
24a7fc8
Add new product screenshot
baristaGeek Jun 13, 2023
0e55581
Fix integrations table
baristaGeek Jun 13, 2023
55a027e
Fix integraitons table
baristaGeek Jun 13, 2023
bcabbdb
Fix integraitons table
baristaGeek Jun 13, 2023
853b2fa
Reorganize table
baristaGeek Jun 13, 2023
55ff493
Concatenate sentence to introduction
baristaGeek Jun 16, 2023
4bce4d6
Merge branch 'dev' into chore/update-readme
EstebanDalelR Jun 20, 2023
e0b13e6
Update README.md
EstebanDalelR Jun 20, 2023
3e0c56b
Update README.md
EstebanDalelR Jun 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 17 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Watermelon GitHub Plugin for Visual Studio Code
# Watermelon for Visual Studio Code

[![Report an issue](https://img.shields.io/badge/-Report%20an%20issue-critical)](https://github.com/watermelontools/watermelon-extension/issues)

Expand All @@ -10,49 +10,31 @@
[![Rating](https://img.shields.io/visual-studio-marketplace/r/WatermelonTools.watermelon-tools?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=WatermelonTools.watermelon-tools&ssr=false#review-details)
[![Discord](https://img.shields.io/discord/933846506438541492?style=flat-square)](https://discord.com/invite/H4AE6b9442)

Watermelon is your **Open Source** Code Archeology Toolbox for **Visual Studio Code**. We allow developers to find the most relevant piece of context for a given block of code. We help you __grok__ codebases by indexing information from git, ticketing, and messaging systems.
**Watermelon helps your team merge Pull Requests With Business Value**. Our set of plug-ins help you understand business context, improve your coding velocity and merge PRs like a breeze.

## Free Features
We've built a search algorithm that indexes the most relevant [passive documentation](https://www.watermelontools.com/post/what-is-passive-code-documentation-why-is-it-hard-to-scale-what-to-do-about-it) for a given block of code.

Watermelon has 2 features that you can use for free:
To obtain business context in your IDE, use this extension.

- Hover to get context
- Get most relevant Pull Request
- Get the most relevant Jira Tickets
- Get the most relevant Slack message thread

More integrations coming soon!

### Hover To Get Context

The fastest way to use Watermelon is to hover over a line of code to get its context.

In the image below you can see how hovering over a line of code provides us the following:
To obtain business context in your CI/CD, take a look at our [GitHub Application](https://github.com/apps/watermelon-context)

![hover](https://thumbs.gfycat.com/EcstaticSpryAracari-size_restricted.gif)

- The author and date of the latest commit
- The message of the latest commit
- The number of times the current file has changed
- A button that says "View the code context with Watermelon"
## Integrations

If you want to do a deeper research about the code context history, simply click such button.
We currently support the following integrations

### Get Full Code Context
| | Git | Project Management | Messaging | Documentation |
| :------------ | :------------------------------------ | :----------------- | :-------- | :----------- |
| VS Code | GitHub, GitLab (Beta), Bitbucket (Beta) | Jira | Slack | |
| GitHub App | GitHub, GitLab, Bitbucket | Jira | Slack | Notion |
## Features

Highlight a piece of code to get its full code context from git (free), ticketing and messaging (paid) systems. There are 3 ways you can use this feature.
Watermelon's VS Code extension allows you to obtain business context for a file or block of code via:

NOTE: This takes up to 10 seconds right now. Please be patient while we work on making this faster.

#### Click get code context button on the sidebar
![sidebarButton](https://thumbs.gfycat.com/AccurateKeenLabradorretriever-size_restricted.gif)

#### Click button from the hover context box
![hoverGetContext](https://thumbs.gfycat.com/CharmingSharpChuckwalla-size_restricted.gif)

#### Click get code context button on the right-click menu
![rightClickMenu](https://thumbs.gfycat.com/MeaslyNarrowGoat-size_restricted.gif)
- Hover to get context
- Get code context button (to obtain the complete context)

![watermelon-vscode-extension](https://i.ibb.co/3pGjBJq/IDE-1.png)

## Requirements

Expand Down Expand Up @@ -101,7 +83,7 @@ We use [VS Code's telemetry library](https://github.com/microsoft/vscode-extensi

We also have settings to disable it.

**We _don't_ store your code**
Watermelon [doesn't store your code](https://www.watermelontools.com/post/building-a-code-archeology-toolbox-without-storing-your-code)

## Supporters

Expand Down