From 3b4304073323e0a31109f06c26e12bcd5fe9646d Mon Sep 17 00:00:00 2001 From: mStar Date: Wed, 18 Sep 2024 10:54:39 +0200 Subject: [PATCH] Updated contribution guide --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c35295d..652cad1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,11 +30,16 @@ git checkout -b 1337-prevent-computer-from-exploding ### Development Environment +The project utilises Go (version 1.23+) for almost everything and node/npm (version 18+) for building the frontend. +The go side also makes use of `go generate` for multiple things, primarely in the storage module + We don't have a development environment, because nobody bothered to fill this out. Please add a new build system to the project specifically for your modifications. Bonus points if it's entirely nonsensical, like `npm` in a C project. ### Code Style -Use tabs instead of spaces, descriptive variable names, comments, blah blah blah. Actually, if you're still seeing this, *please* send us pull requests with the worst possible formatting you can come up with. +For go: gofmt rules and should be followed closely + +For anything node: uhhh, yolo, idk yet ### Pull Requests