Contributing to Marp projects
Thank you for taking the time to read how to contribute to our project! This is the basic guideline for contributing to Marp team owned projects.
You can start contributing our project in several ways: improve docs, report bug, request feature, writing code, and so on.
Depending on the project you want to contribute, it might have additional guidelines you should follow at that repository. Please also check the guideline per repository.
ℹ️Would you the first time to contribute OSS? Open Source Guides might help you.
A figure on the left shows the whole of architecture in the Marp ecosystem. Yellow arrows are meaning dependency.
Marpit is the center of the ecosystem and the independent framework for developers. It's designed suitable for not only Marp but also other slide libraries (See examples of collaboration with reveal.js and WebSlides).
You are probably using Marp Core if you are creating a slide deck with Marp. It includes built-in themes, settings that suit for Marp tools, and Markdown extensions that break CommonMark.
And the most of Marp apps (CLI, Web, Desktop...) and integrations (VS Code, React, Vue...) are creating based on Marp Core. Marp CLI is a precious exception that supports Marpit-based converter for power users.
SUPPORT.md if you would like to ask any question.
We have GitHub Discussions to engage with other Marp community members.
Do you have a feedback that is not just a question? We're welcome to report it into Marp owned project.
At first, you should search for similar issues before reporting your issue. It may have already been discussed or resolved in the other issue.
org:marp-team is:issue [keyword] is useful to search issue from across our projects.
If you could not find out a similar issue, you can create a new issue. Please not contain multiple reports into one issue. It should have only one theme.
ℹ️Some projects have consisted of Marp team owned packages based on project architecture. If you know which project causes an issue, please report the issue to that repository. The member of Marp team may transfer the reported issue into the proper repository.
Feature request is welcome because it could give feedback to us.
However, we have to take a moment to judge whether fitting to the project aim and scope. We require clear benefit and strong incentive to work for the request because each our projects should keep simple and smart.
We recommend to post about your request into GitHub Discussions at first. Talk about your new idea with Marp community.
⚠️Did you find a security vulnerability? Report directly to email@example.com instead of opening a new issue.
We highly recommend to use "
- Expected behavior and actual behavior
- Necessary steps and resources to reproduce bug
- Occurred environment (e.g. the version of OS, browser, Node.js, and so on)
You can submit pull request if you have fixed or added useful something to our projects.
Before adding new feature
Marp team is not proactive for enhanceing our syntax, because the custom Markdown flavor may make user's confusions and protests whose are familiar with exist Markdown/CommonMark syntax.
We are always suggesting "Use or create the third-party plugin if you want" rather than adding new syntax. For implementing new syntax and new feature to offical tools, we require able to confirm a worth through a created third-party plugin and many real-world presentations using it. We will consider integrating the plugin as built-in feature if the most of Marp community shows that using the plugin is valuable.
Requirements in pull request
Indicate related issue(s) in description of PR. In many cases, the created PR should already have related problems. GitHub can close issue automatically by keyword.
Keep code styling. We are using yarn package manager, Prettier formatter, and linters for each language. CI build would fail when using the wrong format/style. It could fix by
yarn format --writeand
yarn lint:[lang] --fixin most projects.
Maintain tests. We need to fill code coverage by writing meaningful tests. In many projects, we are setting a threshold of global line coverage to 95%. You could measure coverage in local by running
These are tasks for maintainer, and usually committer doesn't have to worry.
- If there is CHANGELOG.md in a working project, the maintainer has to update it after (or while) merge PR. We're adopting the format based on Keep a Changelog.
The core maintainer can release package or product of marp-team projects.
⚠️You have to use
npmin a release process, and NEVER use
Basically we are following Semantic Versioning.
v0.0.x as the pre-release version. It may update only patch version until reach to the stable implementation even if it has some breakings or incompatible changes.
Maintainer should mark
v0.0.x as "Pre-release" in GitHub release page.
We have automated bumping version with
version npm script in many repositories.
If it is defined in
npm version [major|minor|patch] at latest
master branch to bump version. In many cases, it would add the version tag and update CHANGELOG.md through helper script.
After than, push master branch and tag by
git push && git push --tags. GitHub Actions for Marp team can be automate to publish GitHub Releases generated from updated CHANGELOG.md whenever pushing new tag .
Publish to npm
Several repository provide npm package. The core maintainer can publish package to npm after bumping version.
For the security reason, we are not planned to automate publishing. We require two-factor authentication to publish.
ℹ️Maintainer should configure to check code styling and tests again when running important commands through
preversion(bumping version) and
prepack(publish to npm).