forked from
mitchellh.com/tack
Stitch any CI into Tangled
1# Tack
2
3- Use `go doc` to find documentation for Go packages. For example:
4 `go doc github.com/mitchellh/go-libghostty`. Full syntax is
5 `go doc [<pkg>.][<sym>.]<methodOrField>` for full help output.
6
7## Style Guide
8
9- Comment heavily, but not redundantly. Explain the "why" behind decisions
10 clearly, don't repeat the "what."
11- Try to limit line length below 100 characters, but don't be afraid to break
12 this rule if it improves readability.
13 - Do not make lines too short to follow this rule either. Try
14 to use as much of the max characters as possible without sacrificing
15 readability.
16
17## Go Guide
18
19- Add compile-time interface checks whenever a type implements an interface
20 we care about. For example: `var _ io.Reader = (*MyType)(nil)`.
21
22## Providers
23
24- Buildkite API: <https://buildkite.com/docs/apis/rest-api.md>