Skip to content

Latest commit

 

History

History
61 lines (52 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

61 lines (52 loc) · 2.08 KB

Contributing

Maintaining this repository assumes that you are not using old versions of bash such as 3.x, which is included in MacOS
I recommend using the Nix package manager to prepare base environments.
This repository contains the flake.nix.

After installing asdf, running below command in this repo finishes setups.

$ asdf plugin-add cargo-make https://github.com/kachick/asdf-cargo-make.git
$ asdf install cargo-make
$ makers setup
cargo-make 0.36.2 is already installed
dprint 0.32.1 is already installed
shellcheck 0.8.0 is already installed
shfmt 3.5.1 is already installed
[cargo-make] INFO - Build Done in 1.09 seconds.

help shows providing tasks for developing

$ makers help
check - Should pass before merging PR
check_no_git_diff - asdf built-in "plugin test" requires git managed codes. This prevents unexpected run
empty - Empty Task
format - Run formatters with changes
help - Might help you - (This one)
lint - Run linters without changes
setup - Install dependencies
test - Run tests with `asdf plugin test`

check task should be passed after your commits

$ makers check
[cargo-make] INFO - makers 0.36.2
[cargo-make] INFO - Build File: Makefile.toml
[cargo-make] INFO - Task: check
[cargo-make] INFO - Profile: development
[cargo-make] INFO - Running Task: lint
[cargo-make] INFO - Running Task: check_no_git_diff
[cargo-make] INFO - Running Task: test
Updating cargo-make to your-branch
Already on 'your-branch'
Your branch is up to date with 'origin/your-branch'.
* Downloading cargo-make release 0.36.2...
Archive:  /tmp/asdf.919U/downloads/cargo-make/0.36.2/cargo-make-0.36.2.zip
  inflating: /tmp/asdf.919U/downloads/cargo-make/0.36.2/LICENSE
  inflating: /tmp/asdf.919U/downloads/cargo-make/0.36.2/README.md
  inflating: /tmp/asdf.919U/downloads/cargo-make/0.36.2/makers
  inflating: /tmp/asdf.919U/downloads/cargo-make/0.36.2/cargo-make
cargo-make 0.36.2 installation was successful!
cargo-make 0.36.2
[cargo-make] INFO - Build Done in 3.47 seconds.

How to release

Add and push tag that have v prefix