diff options
author | 2017-06-03 08:26:51 +0100 | |
---|---|---|
committer | 2017-06-03 08:26:51 +0100 | |
commit | 6d52827a8ae37d153299d7c570e1e9ddf26f2256 (patch) | |
tree | 997be898ca1cda90bd04e7ba50721d86fc52e475 /CONTRIBUTING.md | |
parent | ecae087201efbd4ede1c0f90694128fde381ca74 (diff) | |
download | coredns-6d52827a8ae37d153299d7c570e1e9ddf26f2256.tar.gz coredns-6d52827a8ae37d153299d7c570e1e9ddf26f2256.tar.zst coredns-6d52827a8ae37d153299d7c570e1e9ddf26f2256.zip |
doc update (#703)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19d097d0b..4bdb4871d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ -## Contributing to CoreDNS +# Contributing to CoreDNS 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! -### Bug reports +## Bug reports 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. @@ -21,14 +21,14 @@ Please be kind. :smile: Remember that CoreDNS comes at no cost to you, and you'r 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 sure to write tests to assert your change is working properly and is thoroughly 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) 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, best to open an issue first and "claim" it and get feedback before you invest a lot of time. - -### Vulnerabilities +## Vulnerabilities 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. -## Thank you - -Thanks for your help! CoreDNS would not be what it is today without your contributions. - ## Git Hook We use `golint` and `go vet` as tools to warn use about things (noted golint is obnoxious sometimes, @@ -112,3 +107,7 @@ $ dep prune ``` 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. |