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>
This commit is contained in:
Miek Gieben
2019-08-12 18:24:57 +00:00
committed by GitHub
parent 1ef24a8813
commit 6466d01055
2 changed files with 26 additions and 9 deletions

View File

@@ -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