Skip to content

Contributors FAQ

Paul Jolly edited this page Nov 7, 2018 · 7 revisions
  • 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 as follows:
# block: a_test
$ catfile $PWD/a_test.go
$ cat /home/gopher/repo/a_test.go
package a

...

This makes it appropriate for catfile to be used with the PrintBlockOut mdreplace directive as follows:

```go
{{ PrintBlockOut "a_test" }}
```

which results in (code highlighting does not show up in wiki):

```go
$ cat /home/gopher/repo/a_test.go
package a

...
```
  • Command line tools tree and docker are available if required. docker requires some special invocation however from egrunner. See CONTRIBUTING.md for an example
Clone this wiki locally
You can’t perform that action at this time.