Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.47 KB
Raw

Contributing to Melty

Thanks for helping make Melty better!

Feedback

We'd love to hear your feedback at [email protected].

Issues and feature requests

Feel free to create a new GitHub issue for bugs or feature requests.

If you're reporting a bug, please include

  • Version of Melty (About -> Melty)
  • Your operating system
  • Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)

Pull requests

We're working hard to get the Melty code into a stable state where it's easy to accept contributions. If you're interested in adding something to Melty, please reach out first and we can discuss how it fits into our roadmap.

Local development

To get started with local development, clone the repository and open it in Melty or vscode. Then run

# install dependencies
yarn run melty:install

# auto-rebuild extensions/spectacular source
yarn run melty:extension-dev

Then run the default debug configuration.

In the development mode, any changes you make to the ./extensions/spectacular/ directory will be watched and the extension will be built. To see your changes, you must reload the code editor (cmd+R or ctrl+R).

Set up Claude API key

Melty uses Claude, and you may need to set the melty.anthropicApiKey in Melty's settings. You can do that by:

  • Waiting for the editor to launch.
  • Opening preferences by pressing cmd+, or ctrl+,.
  • Searching for melty.anthropicApiKey and setting the API key.