Watermelon GitHub Plugin for Visual Studio Code

Watermelon is an open-source integration between GitHub and Visual Studio Code to document code and view Git Blame. Watermelon makes you an expert on any file instantly by running git blame for you and telling you why a block of code was written that way by someone else. We also help you add documentation to your workflow.

Features

Watermelon has 3 features that you can use:

• Generate Docs for the Repo
• View Git Blame
• View Pull Requests (Beta)

Simply click the Watermelon icon on the sidebar. After that you can click any of the 3 different buttons Watermelon has.

Generate Docs for the Repo

Click to generate a markdown file with our template. The template includes the following sections:

• Author
• Intro
• How to run this project
• Important links

View Git Blame

Highlight a piece of code, and then click the View Git Blame button. We will run Git Blame for you, and give you a table with the Git commit messages relevant to the piece of code you highlighted.

View Pull Requests (Beta)

Highlight a piece of code, and then click the View Pull Requests (Beta) button to run Git Blame on the background. We will get the PR bodies and comments that are relevant to the highlighted piece of code for you.

Depending on the size of your GitHub history, this might take a few seconds.

Alternatively, you can run with our watermelon.start command

You may also highlight and right click on the code, you will find the 'Start Watermelon' command at the end.

Requirements

• macOS 10.11+, Windows 10+ or Linux
• Visual Studio Code v1.63.0+
• You must have Git locally installed (try git --version or 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.

Commands

Watermelon comes with a command 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.

Commands for the other 2 features coming soon.

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 Slack community. Alternatively, comment on our issues if you plan to solve one.

Analytics

We track users to improve our application. We store your GitHub username and whether your Watermelon query was successful or not.

We don'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 Slack community, follow us on Twitter and go to the Watermelon blog to get the best programming tips.

License

• Apache License