Files
drone-jsonnet-generator/CONTRIBUTING.md
Suzuki Shunsuke e98c3135cd ci: add build and ci tools
* Drone
* golangci-lint
* goreleaser
* commitlint
* scripts
* README, CONTRIBUTING
2019-06-12 09:57:25 +09:00

2.1 KiB

Contributing

Check before send a pull request

Requirements

We use node libraries and npm scripts for development. Please see package.json .

Set up

$ npm run setup

Lint

# Lint with go vet.
$ npm run vet
# Lint with golangci-lint. It takes some time.
$ npm run lint

Format codes with gofmt

$ npm run fmt

Test

$ npm t
# Test with Drone
$ npm run ci-local

Commit Message Format

The commit message format of this project conforms to the AngularJS Commit Message Format. We validate the commit message with git's commit-msg hook using commitlint and husky, so you have to install them before commit.

$ npm i

Release

$ npm run tag <tag>
$ git push
$ git push --tags

Tag must start with "v". npm run tag command updates internal/domain/version.go and commit and creates a tag. When we push a tag to GitHub, ci is run and drone-jsonnet-generator is built and uploaded to GitHub Relases .

CI

We use Drone.

Please see .drone.yml .