Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
C
Coredns
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Railgun
Coredns
Commits
6d52827a
Commit
6d52827a
authored
Jun 03, 2017
by
Miek Gieben
Committed by
GitHub
Jun 03, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc update (#703)
parent
ecae0872
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
22 additions
and
11 deletions
+22
-11
CONTRIBUTING.md
CONTRIBUTING.md
+9
-10
middleware.md
middleware.md
+13
-1
No files found.
CONTRIBUTING.md
View file @
6d52827a
#
#
Contributing to CoreDNS
# Contributing to CoreDNS
Welcome! Our community focuses on helping others and making CoreDNS the best it
Welcome! Our community focuses on helping others and making CoreDNS the best it
can be. We gladly accept contributions and encourage you to get involved!
can be. We gladly accept contributions and encourage you to get involved!
##
#
Bug reports
## Bug reports
First, please
[
search this repository
](
https://github.com/coredns/coredns/search?q=&type=Issues&utf8=%E2%9C%93
)
First, please
[
search this repository
](
https://github.com/coredns/coredns/search?q=&type=Issues&utf8=%E2%9C%93
)
with a variety of keywords to ensure your bug is not already reported.
with a variety of keywords to ensure your bug is not already reported.
...
@@ -21,14 +21,14 @@ Please be kind. :smile: Remember that CoreDNS comes at no cost to you, and you'r
...
@@ -21,14 +21,14 @@ Please be kind. :smile: Remember that CoreDNS comes at no cost to you, and you'r
getting free help.
getting free help.
##
#
Minor improvements and new tests
## Minor improvements and new tests
Submit
[
pull requests
](
https://github.com/coredns/coredns/pulls
)
at any time. Make
Submit
[
pull requests
](
https://github.com/coredns/coredns/pulls
)
at any time. Make
sure to write tests to assert your change is working properly and is thoroughly
sure to write tests to assert your change is working properly and is thoroughly
covered.
covered.
##
#
Proposals, suggestions, ideas, new features
## Proposals, suggestions, ideas, new features
First, please
[
search
](
https://github.com/coredns/coredns/search?q=&type=Issues&utf8=%E2%9C%93
)
First, please
[
search
](
https://github.com/coredns/coredns/search?q=&type=Issues&utf8=%E2%9C%93
)
with a variety of keywords to ensure your suggestion/proposal is new.
with a variety of keywords to ensure your suggestion/proposal is new.
...
@@ -48,16 +48,11 @@ If you are going to spend significant time implementing code for a pull request,
...
@@ -48,16 +48,11 @@ If you are going to spend significant time implementing code for a pull request,
best to open an issue first and "claim" it and get feedback before you invest
best to open an issue first and "claim" it and get feedback before you invest
a lot of time.
a lot of time.
## Vulnerabilities
### Vulnerabilities
If you've found a vulnerability that is serious, please email me:
<miek@miek.nl>
.
If you've found a vulnerability that is serious, please email me:
<miek@miek.nl>
.
If it's not a big deal, a pull request will probably be faster.
If it's not a big deal, a pull request will probably be faster.
## Thank you
Thanks for your help! CoreDNS would not be what it is today without your contributions.
## Git Hook
## Git Hook
We use
`golint`
and
`go vet`
as tools to warn use about things (noted golint is obnoxious sometimes,
We use
`golint`
and
`go vet`
as tools to warn use about things (noted golint is obnoxious sometimes,
...
@@ -112,3 +107,7 @@ $ dep prune
...
@@ -112,3 +107,7 @@ $ dep prune
```
```
Please refer to Golang's
[
`dep`
](
https://github.com/golang/dep
)
for more details.
Please refer to Golang's
[
`dep`
](
https://github.com/golang/dep
)
for more details.
# Thank you
Thanks for your help! CoreDNS would not be what it is today without your contributions.
middleware.md
View file @
6d52827a
...
@@ -33,7 +33,7 @@ something has been written to the client (by the middleware).
...
@@ -33,7 +33,7 @@ something has been written to the client (by the middleware).
See a couple of blog posts on how to write and add middleware to CoreDNS:
See a couple of blog posts on how to write and add middleware to CoreDNS:
*
<https://blog.coredns.io/
#>
TO BE PUBLISHED.
*
<https://blog.coredns.io/
2017/03/01/how-to-add-middleware-to-coredns/>
*
<https://blog.coredns.io/2016/12/19/writing-middleware-for-coredns/>
, slightly older, but useful.
*
<https://blog.coredns.io/2016/12/19/writing-middleware-for-coredns/>
, slightly older, but useful.
## Metrics
## Metrics
...
@@ -132,3 +132,15 @@ answer for the MX query:
...
@@ -132,3 +132,15 @@ answer for the MX query:
% dig +nocmd @localhost +noall +ans MX compute.internal
% dig +nocmd @localhost +noall +ans MX compute.internal
compute.internal. 3600 IN MX 10 mx.compute.internal.
compute.internal. 3600 IN MX 10 mx.compute.internal.
~~~
~~~
## Qualifying for main repo
Middleware for CoreDNS can live out-of-tree,
`middleware.cfg`
defaults to CoreDNS' repo but other
repos work just as well. So when do we consider the inclusion of a new middleware in the main repo?
*
First, the middleware should be useful for other people. "Useful" is a subjective term. We will
probably need to further refine this.
*
Current internet standards need be supported: IPv4 and IPv6, so A and AAAA records should be
handled (if your middleware is in the business of dealing with address records that is).
*
It must have tests.
*
It must have a README.md for documentation.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment