mirror of
https://github.com/suzuki-shunsuke/drone-jsonnet-generator.git
synced 2026-02-10 00:22:21 +02:00
2.1 KiB
2.1 KiB
Contributing
Check before send a pull request
- Commit message format conforms the AngularJS Commit Message Format
- Commit message type is appropriate
- If the pull request includes breaking changes, please describe them
- Document and code comment is updated
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 .