From c0046ec2493dd92a543373f8c3dc9a074c7a42c9 Mon Sep 17 00:00:00 2001 From: Lexie Date: Mon, 23 Sep 2024 15:14:20 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f718ffb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## How to contribute? +1. Clone the repo +2. cd +3. Use the `shell.nix` file, or use some other shenanigans, i dont care. + +### Subfolders: +- `app` : + - `pnpm i && wrangler dev` + +- `api` : + - `pnpm i && tsc && node dist/index.js` + +I don't really enforce a branch naming convention, but please, refrain from making a PR if you have pushed your changes on the `mistress` branch. +Same with commits, just make them readable and understandable at first glance. + +Submit your changes! + +Tysm <3