Add a note about the style of git tests

mislav · mislav · commit 492f45422ecd · 2021-02-26T13:07:38.000+01:00
diff --git a/git/git_test.go b/git/git_test.go
@@ -42,6 +42,12 @@ func TestCommitBody(t *testing.T) {
 	}
 }
 
+/*
+	NOTE: below this are stubbed git tests, i.e. those that do not actually invoke `git`. If possible, utilize
+	`setGitDir()` to allow new tests to interact with `git`. For write operations, you can use `t.TempDir()` to
+	host a temporary git repository that is safe to be changed.
+*/
+
 func Test_UncommittedChangeCount(t *testing.T) {
 	type c struct {
 		Label    string

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,12 @@ func TestCommitBody(t *testing.T) {`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
	`45`	`+/*`
	`46`	+ NOTE: below this are stubbed git tests, i.e. those that do not actually invoke `git`. If possible, utilize
	`47`	+ `setGitDir()` to allow new tests to interact with `git`. For write operations, you can use `t.TempDir()` to
	`48`	`+ host a temporary git repository that is safe to be changed.`
	`49`	`+*/`
	`50`	`+`
`45`	`51`	`func Test_UncommittedChangeCount(t *testing.T) {`
`46`	`52`	`type c struct {`
`47`	`53`	`Label string`