Skip to content

Commit f2e756d

Browse files
authored
Merge pull request grafana#1361 from grafana/misc
Misc doc tweaks
2 parents 394cfc9 + 28f63c3 commit f2e756d

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

docs/CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ see the [Makefile](../Makefile) for more targets
2121
1. functions, methods, types should be clearly understandable, either through an obvious name, or documentation when needed.
2222
2. all code documentation must conform to [golang best practices](https://blog.golang.org/godoc-documenting-go-code)
2323
3. add unit tests for tricky or non-trivial code. Not needed for obvious, simple or glue code. Use your best judgment or just ask us.
24+
For bugfixes, construct the git history such that the commit introducing the test comes before the bugfix, this makes it much easier to validate the fix.
2425
4. add benchmarks for performance sensitive functionality (e.g. code in the read and write path) or commonly executed code. (e.g. index inserts and searches)
2526
([how to write benchmarks tutorial](https://dave.cheney.net/2013/06/30/how-to-write-benchmarks-in-go))
2627
5. It's OK for your PR to not be based on the absolute latest master, but don't let the base of your branch get too out of date. (rule of thumb: no more than 40 commits or 2 weeks behind)

docs/http-api.md

+1
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ curl -s http://localhost:6060/priority | jsonpp
198198
}
199199
}
200200
]
201+
```
201202

202203
## Cache delete
203204

0 commit comments

Comments
 (0)