From db26b0ff7d3d5811a6866c28d615c42103515bc4 Mon Sep 17 00:00:00 2001 From: Ralph Date: Wed, 2 Oct 2024 21:17:19 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ec32898 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contributing + +Thanks for considering contributing! + +A few rules of thumb: +- This repository uses PNPM. +- Code contributions should match the existing code style. + - `pnpm lint` to check the formatting + - `pnpm lint:fix` to fix some of the issues +- Discuss additions/changes with us [on Discord](https://discord.gg/fJrZZ7V) before working on them. +- Make sure to run your own instance and ensure minor/major/dependency changes work correctly.