Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 1.25 KB

Contributing to marked-extensions

Dev Commands

Install and build:

npm install

Start a watcher:

npm run watch

Changesets

Changesets are used to automate version bumping and releasing the packages.

If you contribute anything that results in a version bump, you ned to write a changeset describing the changes.

To write a changeset, run npx changeset and follow the instructions shown. A new changeset will be added to .changesets/.

When changesets are pushed to master, a PR will be created automatically to keep track of the next version bump. Merging the PR bumps the versions, and release the affected packages.

See Adding a changeset for more.

Code Style

Prettier is used to ensure consistent style. Single quote and wider print width (100) is used to be similar to the original code style of the project.

pre-commit hook to format staged changes is installed automatically when you run npm install, so you don't need to do anything. However, it's recommended to configure your editor to format on save, and forget about formatting.