~whereswaldon/arborchat

a48bcf352c9758f043df6faf7f38356018b7713f — Amolith 10 months ago 976200a
add contributing doc and mention vale linting
1 files changed, 8 insertions(+), 0 deletions(-)

A contributing.md
A contributing.md => contributing.md +8 -0
@@ 0,0 1,8 @@
---
title: Contributing
summary: Information and guides about contributing to the Arbor project
---

# Code
# Documentation
We use [vale](https://errata-ai.gitbook.io/vale/) to lint our docs and enforce stylistic consistency. Installation is quick and fairly simple; just download the [latest release](https://github.com/errata-ai/vale/releases/latest) for your platform and unpack the tarball somewhere, taking note of the location. From there, simply run `/path/to/vale <file.md>` to check what you've written against the rules we've created. Correct all the errors and at least *reduce* the number of warnings/suggestions; it's fine if you don't completely eliminate them.