Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 2.67 KB

Contributing to Watermelon's extension development

For now, we discuss on Discord.

Anyone is free to contribute changes to any file in this repository. You don't need to ask for permission or get in line. If you see an issue that's open and it seems interesting to you, feel free to pick it up. Your solution may be better. Open-source is beautiful.

Running the extension

To run:

  1. Open the folder containing the code on VSCode.
  2. Run npm install.
  3. Press "F5" or go to the debug panel and click "Run Extension".

Make sure you:

  1. Have logged in with your github account on VSCode.
  2. The folder you are accessing is NOT in restricted mode.

When commiting, our all the tests will run to check nothing broke.

Issues

If there's something you'd like to see please open an issue.

PRs

We love community contributions. Please fork the repo and send a PR our way.

Remember, we'll discuss it publicly, it's a great opportunity to learn.

Sources

VSCode

Octokit (SDK for GitHub)

Brand

We prefer to use Codicons and Primer Design for our extension, but are elastic in UI decisions.

Donations

We have Github Sponsors
Also star ⭐ the repo to help!

Release

VSCode

To release a new version of the extension, we use vsce. This requires being part of the team and having access to the VSCode Marketplace.

First, create a PR from dev to master with the title v{version_number} (e.g. v1.6.3). Then, test it and get at least one approval.

Second, on your local machine, pull the latest master and run vsce publish {version_name}. This will publish the new version to the marketplace.

VSCodium

We use the .vsix from the VSCode Marketplace to publish to VSCodium. After the previous steps, run npx ovsx publish -p {your_token} to release the new version to VSCodium. This generally takes longer than the VSCode Marketplace.