Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (24 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.39 KB
Raw

How to contribute

Understanding the setup

The scripts in packagage.json are used to manage this project.

  • running yarn install runs the postinstall script, which sets up pre-commit scripts that run lints (see below) before each git commit.
  • watch and compile can be used to compile the TypeScript sources, but “Run Extension” in .vscode/launch.json also runs watch for you.
  • lint runs the following:
    • lint:check runs the Biome linter and formatter.
    • lint:deps runs depcheck to see if we have superfluous dependencies.
  • vsce-package builds the VS Code extension.

updating the logo

  • edit assets/hatch-logo.fig with Figma
  • export to SVG
  • convert to font using https://icomoon.io/
  • replace assets/hatch-logo.woff2

(The logo.png is a copy of the regular Hatch logo, resized to 128px.)

CI/CD tokens

To update the MARKETPLACE_TOKEN secret, we can follow the “publishing extensions” tutorial.

Azure is weird, so in order to create an organization-independent PAT to publish extensions to the marketplace, one still needs access to an organization.

I personally have access to the scverse org so I’ll use that: token settings (Select “Access scope: All accessible organizations” in the filter list)