luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

contrib: update config checklist docs

This commit is contained in:
Daniel Nephin 2020-12-21 17:08:42 -05:00
parent 78b02663e9
commit f8e739c58f
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
contributing/checklist-adding-config-fields.md
View File

@ -33,9 +33,9 @@ There are four specific cases covered with increasing complexity:
`TestFullConfig` in `agent/config/runtime_test.go`, it should fail now, then `TestFullConfig` in `agent/config/runtime_test.go`, it should fail now, then
add the same random value to the expected struct in that test so it passes add the same random value to the expected struct in that test so it passes
again. again.
- [ ] Add the new field and it's default value to `TestSanitize` in the same - [ ] Run `go test -run TestRuntimeConfig_Sanitize ./agent/config -update` to update
file. (Running the test first gives you a nice diff which can save working the expected value for `TestRuntimeConfig_Sanitize`. Look at `git diff` to
out where etc.) make sure the value changed as you expect.
- [ ] **If** your new config field needed some validation as it's only valid in - [ ] **If** your new config field needed some validation as it's only valid in
some cases or with some values (often true). some cases or with some values (often true).
- [ ] Add validation to Validate in `agent/config/builder.go`. - [ ] Add validation to Validate in `agent/config/builder.go`.