Skip to content

Commit

Permalink
add contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
pandermatt committed Mar 15, 2024
1 parent 182d944 commit 372c544
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,18 @@ Please make sure you have test coverage for anything you add or fix!
Please add a CHANGELOG entry with any relevant tags for issues, pull-requests, and authors.

Thanks for you contribution!

### Modify the Documentation

The documentation is written in Markdown and is located in the `docs` directory. The documentation is built using [VitePress](https://vitepress.dev).

```bash
npm install
npm run dev

# build for production, resulting in a static site in docs/.vitepress/dist
npm run build
```

Before submitting a pull request, please make sure the documentation builds correctly using `npm run build`.
Most likely the build will fail if there are any syntax errors in the markdown files or dead links.

0 comments on commit 372c544

Please sign in to comment.