Thank you for taking the time to read how to contribute to Marpit! This is the guideline for contributing to Marpit.
We are following the contributing guideline of marp-team projects. Please read this before starting work.
When sending pull request updated the interface of public class, it's better to mind to these resources.
- JSDoc (for API documentation)
- Documents (at
/docs/) /index.d.ts(Type definition for TypeScript)
The core maintainer can release package to npm. For the security reason, we are not planned to automate release. We require two-factor authentication to release.
In a release process, you have to use npm command instead of yarn.
- Run
npm version [major|minor|patch]at latestmasterbranch. It adds tag and updates CHANGELOG.md. - Push branch and tag by
git push && git push --tags. - Release package to npm by
npm publish. - Update GitHub release if possible.
ℹ️ In running important commands, code styling and tests are checked again through
preversionandprepackscripts.