📖 Add CONTRIBUTING.md

Add `bin/bindl-dev` rule in Makefile to bootstrap with `go build`.

Author: wilsonehusin

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+Thank you for your interest in Bindl. We welcome and encourage public contributions.
+
+Prior to submitting code changes, we ask that you communicate the proposal and reach an agreement (typically in GitHub Issues) to help reviewers and increase the likelihood of accepting the changeset.
+
+## Development environment
+
+Ironically, as a project for dependency management, we have some dependencies which are not contained by `bindl.yaml`. While they are not _strictly necessary_, they are a convenient compromise. We are certainly open to alternatives. Until then, the project makes use of:
+
+- **GNU Make** version 4.3
+- [**direnv**](https://direnv.net)
+
+The good news is that other dependencies are listed in this project's own `bindl.yaml`. To set them up, start with bootstrapping Bindl.
+
+### Bootstrapping Bindl
+
+If you haven't already have Bindl in your `$PATH`, use one of the following methods:
+
+- `make bin/bindl` to use latest release
+- `make bin/bindl-min` to compile from currently checked-out state
+
+## Ensuring continuous integration
+
+The project uses GitHub Actions to run continuous integration tasks. The CI pipeline invokes various Makefile rules to reduce development environment vs CI variability.
+
+```bash
+# To run tests:
+make test/all
+# or look inside Makefile on which specific tests you'd like to run.
+
+# To run linters:
+make lint
+# and to run auto-fixer:
+make lint/fix
+
+# To make development builds:
+make bin/bindl-dev
+# This specifically invokes goreleaser to emulate builds on release
+```

Makefile

@@ -15,6 +15,10 @@ GO?=go
 bin/bindl:
 	OUTDIR=bin ./bootstrap.sh
 
+.PHONY: bin/bindl-min
+bin/bindl-min:
+	${GO} build -o bin/bindl ./cmd/bindl
+
 .PHONY: bin/bindl-dev
 bin/bindl-dev: bin/goreleaser
 	bin/goreleaser build \

README.md

@@ -31,25 +31,6 @@ You may try to install with `go get`, though versioning information may be incom
 
 And of course, [assets in releases](https://github.com/bindl-dev/bindl/releases) are downloadable for manual binary installation.
 
-## Developing Bindl
+## Contributing to Bindl
 
-### Dependencies
-
-To develop on Bindl, you may need to setup several programs:
-- GNU Make
-- [direnv](https://direnv.net/)
-
-If your project relies on Bindl, the programs above are optional, but recommended as there are workflows which integrates well with them.
-
-### Git hooks
-
-If your project utilizes Bindl and Makefile, it is recommended to use [Git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), specifically `post-checkout`:
-
-
-```sh
-touch .bindl-lock.yaml
-```
-
-By running the line above every successful `git checkout`, your Make rules will forcibly rebuild binary dependencies the next time its invoked. Bindl will then validate if existing program is consistent with lockfile (i.e. `.bindl-lock.yaml`) and let user proceed if it is. Otherwise, Bindl will attempt to lookup locally and fallback to downloading the program.
-
-This is particularly important when working with branches which has different versions of programs declared in `.bindl-lock.yaml`, because Bindl can enforce consistency with the current branch.
+Our guide on contributing to Bindl is specified in [`CONTRIBUTING.md`](CONTRIBUTING.md)