Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (24 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.41 KB

Contributing

Getting Started

To start working on Markprompt, see the GitHub Contributing to projects documentation.

After cloning, you need to install dependencies using npm:

npm ci

Markprompt is linted using ESLint and Prettier. It is type checked using TypeScript. To verify your changes, run:

npm run lint

When you open a pull request, this is also run by our GitHub Actions ci workflow to make sure all code conforms to the code quality standards.

You can format all code using the prettier command:

npx prettier --write .

Releases are managed using Changesets. You need to add a changeset for changes that need a release. To add a changeset, run the following command, and follow the instructions from the command line:

npx changeset

Don’t forget to commit the generated changeset!

Releasing

Note This section is only for maintainers

Releases are managed using Changesets. If there are any changesets present, Changesets will open a pull request. Merging this pull request will publish all updated packages to npm and create a GitHub release.