Commit Graph

8 Commits (76905ba3bc40a2afa0c4a113be6278d126a3cc90)

Author SHA1 Message Date
Daniel Martí 8e7765ee6f CONTRIBUTING: introduce -toolexec and add more dev tips
I've explained this before, such as over chat or talks with slides,
so it's time to have a proper version in our docs.

It doesn't really belong in the README, because a user shouldn't have to
understand these internal details.

The way Go builds with -toolexec spawn sub-processes is a bit tricky,
so I've attempted to demonstrate it with a vertical tree using Unicode.
Each added indentation level is one more sub-process level.
Daniel Martí bd0705a536 amend redirecting URLs via "xurls -fix"
Daniel Martí 5d49955998 README: document commands
While at it, slightly tweak and update the rest of the markdown docs.
Daniel Martí 1336711c9c
CONTRIBUTING: include some basic terminology ()
Fixes .
Daniel Martí 6b6a6eee2e
CONTRIBUTING: clarify that tests are required ()
See https://github.com/burrowers/garble/issues/121#issuecomment-695935859.

In some rare cases, it's nearly impossible to write a test for a change,
but they are truly so rare that we shouldn't give any ideas here.

By default, all contributors should try to write a test for every
change that changes what the code is meant to do.
Daniel Martí 805c895d59 set up an AUTHORS file to attribute copyright
Many files were missing copyright, so also add a short script to add the
missing lines with the current year, and run it.

The AUTHORS file is also self-explanatory. Contributors can add
themselves there, or we can simply update it from time to time via
git-shortlog.

Since we have two scripts now, set up a directory for them.
Daniel Martí cfd45d9a18
PRs with one review and CI are now mandatory ()
Daniel Martí 9c4b7d5a44 add the first benchmark and CONTRIBUTING doc