Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.3 KB

Contributing

Welcome! Here's what you need to know when contributing to this repo.

Folders & Files

  • docs: markdown files that will be converted into html pages by docsify
  • .spelling: used by markdown-spellcheck to whitelist words

Tasks

deps:install  # install all dependencies required to run this project
lint          # performs lint validations on all relevant *.md files
pr:prepare    # checks if your branch is good enough for a Pull Request
pr:preview    # runs the website locally on your machine
pr:ready      # makes your branch ready for Pull Request (increments version)
test          # checks if the live website is ok
clean         # deletes unversioned generated files

To run a task use npm run <task>, e.g. npm run pr:prepare.

Details

How to use Markdown linting

  • Install: npm i -g markdownlint-cli
  • Run validation: markdownlint docs --config .markdownlint.json

Configure which rules or groups of rules should be globally used with a .markdownlint.json file.