diff --git a/Contributing.md b/Contributing.md index 27d2cea..f674f7b 100644 --- a/Contributing.md +++ b/Contributing.md @@ -1 +1,23 @@ -Yay \ No newline at end of file +Have a feature you want to implement into Statup!? Awesome! Follow this guide to see how you can test, compile and build Statup for production use. + +# Testing +Statup includes multiple ways to Test the application, you can run the `make` command, or the normal `go test` command. To see the full experience of your updates, you can even run Cypress tests which is in the `.dev/test` folder. + +###### Makefile Command: +```bash +make test-all +``` +###### Golang Command: +```bash +VERSION=0.44 +STATUP_DIR=`pwd` +go test -v -p=1 -ldflags "-X main.VERSION=$(VERSION)" -coverprofile=coverage.out ./... +``` +###### Cypress UI Testing: +```bash +cd .dev/test +npm test +``` + +# Build +