mirrors
/
gotosocial
mirror of
1
Fork 0
Code Issues Releases Activity

update CONTRIBUTING with css bundling instructions, and go fmt (#48)

This commit is contained in:
f0x52 2021-06-19 09:29:49 +02:00 committed by GitHub
parent 82d9f88e42
commit ad2e982edc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -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.