TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

contrib: add words on adding new plugins (#3057)

Browse source 
* contrib: add words on adding new plugins

New plugins are usually dropped in one giant ball of code, add some
words on how this can be approached and made to work faster.

(will at least give us something to point at)

Signed-off-by: Miek Gieben <miek@miek.nl>

* Update CONTRIBUTING.md

Co-Authored-By: Michael Grosser <development@stp-ip.net>

* Update CONTRIBUTING.md

Co-Authored-By: Michael Grosser <development@stp-ip.net>

* Update CONTRIBUTING.md

Co-Authored-By: Michael Grosser <development@stp-ip.net>

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-Authored-By: Michael Grosser <development@stp-ip.net>
This commit is contained in:
Miek Gieben 2019-07-28 10:02:38 +00:00 • committed by GitHub
parent 92a636df53
commit b209cb162c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -42,6 +42,16 @@ If possible make a pull request as small as possible, or submit multiple pull re
feature. Smaller means: easier to understand and review. This in turn means things can be merged
faster.
## New Plugins
A new plugin is (usually) about 1000 lines of Go. This includes tests and some plugin boiler
plate. This is a considerable amount of code and will take time to review. To prevent too much back and
forth it is advisable to start with the plugin's `README.md`; This will be it's main documentation and will help
nail down the correct name of the plugin and its various config options.
From there it can work its way through the rest (`setup.go`, the `ServeDNS` handler function,
etc.). Doing this will help the reviewers, as each chunk of code is relatively small.
## Updating Dependencies
We use [Go Modules](https://github.com/golang/go/wiki/Modules) as the tool to manage vendor dependencies.