Contributors FAQ

• Standardise on creating examples in $HOME/scratchpad/XYZ
• Use the gopher user that is the default for egrunner
• Use assert "$? -eq 1" $LINENO to assert something other than a zero exit code on the line after a command. This assert call will not appear in output
• Use catfile /path/to/file to "pretty print" a file with a comment header of the comment file name followed by a blank line. // is assumed as the comment unless passed as a second argument. The output is generally appropriate for use in PrintBlockOut within a code block with the approach language marked for syntax highlighting.

$ catfile $PWD/a_test.go
// /home/gopher/repo/a_test.go

package a

...
$ catfile script.sh '#'
# script.sh

package a

...