Create CONTRIBUTING.md

2024-09-23 15:14:20 +02:00
parent a8d02c4353
commit c0046ec249
1 changed files with 18 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ 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