Skip to content

Latest commit

 

History

History
54 lines (29 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

54 lines (29 loc) · 1.1 KB

💼 Contributing

💽 Development

Run the setup script:

./scripts/setup.sh

Run the following command to run the application:

go run github.com/techygrrrl/sf6vid

🖥 Requirements

✅ Testing

Run the tests with the following command:

go test -v ./...

To run tests with coverage run:

go test -v ./... -cover

Write any operating-specific tests in a file for that operating system, e.g. os_utils_linux_test.go will only run on Linux.

🧹🕸 Linting

Use goimports for formatting and linting, and gci for import order.

Install it:

go install golang.org/x/tools/cmd/goimports@latest
go install github.com/daixiang0/gci@latest

Run it:

goimports -w . && gci write .

🚀 Releasing

Uses goreleaser.