Show HN: Watermelon – open-source VSC ext. to document code and view Git blame
https://github.com/watermelontools/wm-extension
Hey there HN! We're a pair of devs looking to get feedback for our open-source project.We're remote engineers who have contracted for many clients overseas. There's a problem that all codebases share: Onboarding devs to a new codebase is hard no matter what.
We're also open-source engineers and learned about the techniques used in OSS to tackle the problem. Please give us your feedback.
Homepage: https://watermelon.tools/
Repo: https://github.com/watermelontools/wm-extension
Install: https://marketplace.visualstudio.com/items?itemName=Watermel...
(
42 comments
| 84 points
| on HN
)
Suddenly they decided to comment for the first time on this specific submission.
And all within one hour.
And all to basically write the same thing.
The Watermelon authors are lucky or maybe it is Friday the 13th.
I saw that Watermelon was on HN and I did made a first comment, because I have been following the project and I like to support other founders who happen to be my friends.
And indeed, they are "lucky" to have people that like the team and project. Hope that it is the same case with you and people that you know :).
Note: This is the first time I looked at the origins of comments in a submission because they really looked like fake comments and this annoyed me terribly as I want HN to stay free of them.
Anyways, hope you get the opportunity to try Watermelon and give them an unbiased opinion (as I probably would do), which will help them :)
Our close friends did notice we launched. Lol.
It isn't very hard to click on the usernames after you see some suspicious messaging from similar accounts.
- GitLens is the extension every Git user should have installed, and it for example automatically gives you the git blame on every line
Then depending a bit on the version control system & language used, there are "native" extension for PR and documentation.
- Github pull requests & issues integrates nicely with the GitLens blame - hover the blame and you'll see the PR. Also has bunch of PR & Issues related functionalities
- autoDocstring (Python) for generating documentation "automatically" inside the code, where it belongs IMHO.
1. GitLens is useful but it only gives you the author of a line, and the commit message. We can do way better than that as we keep indexing info from more sources + organize it in different ways
2. Similar as number 1. We will index info from more sources and organize it better.
3. Didn’t know about autoDocstring but it looks like a great analogous tool to JSDoc. We’ve used JS Doc and think it’s great for documenting functions. However, we believe there is an opportunity for documenting greater level stuff such as the architecture and the relations between modules.
I had the pleasure of working with Esteban (aka baristaGeek) at Cerebrum. Great guy. There’s a saying that the best employees go on to be founders, and I can definitely see that in what Watermelon is becoming. Very exciting!
And yes! The code onboarding problem is always there. Watermelon providing that historical context is huge.
P.S. I just happened to find this at the bottom of the homepage. I had no idea Esteban would be posting here, I just browse HN a lot.
Hope we're adding value with our historical context tool. Always glad to listen to your feedback.
1. We are already available for private repos. If you authenticate you’ll be able to use us on any GH private repo
2. Yes! We’re exploring integrating Notion, Jira, and Slack. Stay tuned!
1. We track which GitHub usernames and repos that use Watermelon, it's the only thing we track. This allows us to go to people and ask them for more detailed feedback. We also get feedback from stargazers and forkers. Because we're open source, people also leave GH issues.
2. The incentive is something very basic: They wanna see a better version of this out there in the world.
Sorry, but I don't think you should request feedback from users without their explicit permission. Isn't there a feedback mechanism built into VSCode already, or make and affordance for one in your plugin UI? Maybe at best generate a random install ID that can be reset for analytics and session tracking? VSCode has guidelines for this, see [2].
[1] https://github.com/watermelontools/wm-extension/blob/c389125...
[2] https://code.visualstudio.com/api/extension-guides/telemetry...
any plans for building extensions for various issue/work tracking systems, wikis, email archives, etc? i've longed for comprehensive views across tickets, pull requests, bug reports and wikis for all relevant knowledge for a given effort in past.
What's your opinion about the create docs direction we're exploring to complement your Indiana Jones coding? (Love your "code archeology" term).
i'm more interested in tooling that gives as much context as possible for why something is the way it is. code ages like a novel would as passed through the telephone game. the more context that is readily available for each generation of changes, the more consistent the design remains in the long run.
also, it's incredibly handy when in emergency breakfix situations.