diff options
| author |  Miek Gieben <miek@miek.nl>
| 2019-08-12 18:24:57 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2019-08-12 18:24:57 +0000 |
| commit | 6466d010557383620b5887f2754560773ca55088 (patch) | |
| tree | fea24eaabf108d788f33882a8ea84e47a130b372 /plugin.md | |
| parent | 1ef24a881391047d55628fc32b058a60552c9ede (diff) | |
| download | coredns-6466d010557383620b5887f2754560773ca55088.tar.gz coredns-6466d010557383620b5887f2754560773ca55088.tar.zst coredns-6466d010557383620b5887f2754560773ca55088.zip | |
doc: formatting and point to plugin.md (#3107)
* doc: formatting and point to plugin.md
Slight tweaks in CONTRIBUTING.md and point to plugin.md which also has a
bunch of info.
Signed-off-by: Miek Gieben <miek@miek.nl>
* Update plugin.md
Co-Authored-By: Chris O'Haver <cohaver@infoblox.com>
* Add minimize to configuration knobs
Signed-off-by: Miek Gieben <miek@miek.nl>
* more
Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'plugin.md')
| -rw-r--r-- | plugin.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -117,6 +117,16 @@ The `fallthrough` directive should optionally accept a list of zones. Only queri in one of those zones should be allowed to fallthrough. See `plugin/pkg/fallthrough` for the implementation. +## General Guidelines + +Some general guidelines: + +* logging time duration should be done in seconds (call the `Seconds()` method on any duration). +* keep logging to a minimum. +* call the main config parse function just `parse`. +* try to minimize the number of knobs in the configuration. +* use `plugin.Error()` to wrap errors returned from the `setup` function. + ## Qualifying for Main Repo Plugins for CoreDNS can live out-of-tree, `plugin.cfg` defaults to CoreDNS' repo but other |