commit ad2e982edc08c4c8a1dce68a1cfbec2fc03a5d08
parent 82d9f88e424fffacfa9a9c1c26f2f702b97f3e3a
Author: f0x52 <f@0x52.eu>
Date: Sat, 19 Jun 2021 09:29:49 +0200
update CONTRIBUTING with css bundling instructions, and go fmt (#48)
Diffstat:
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,6 +34,8 @@ Once that's done, you can try building the project: `go build ./cmd/gotosocial`.
If there are no errors, great, you're good to go!
+To work with the stylesheet for templates, you need [Node.js](https://nodejs.org/en/download/), then run `yarn install` in `web/source/`. Recompiling the bundle.css is `node build.js` but can be automated with [nodemon](https://www.npmjs.com/package/nodemon) on file change: `nodemon -w style.css build.js`.
+
## Setting up your test environment
GoToSocial provides a [testrig](https://github.com/superseriousbusiness/gotosocial/tree/main/testrig) with a bunch of mock packages you can use in integration tests.
@@ -90,10 +92,10 @@ To run the linter, use:
golint ./...
```
-
+Then make sure to run `go fmt ./...` to update whitespace and other opinionated formatting.
## Financial Compensation
Right now there's no structure in place for financial compensation for pull requests and code. This is simply because there's no money being made on the project apart from the very small weekly Liberapay donations.
-If money starts coming in, I'll start looking at proper financial structures, but for now code is considered to be a donation in itself.
+If money starts coming in, I'll start looking at proper financial structures, but for now code is considered to be a donation in itself.
+\ No newline at end of file
