From ee6c5f87d1ef5a00cf4383946ef6b98fe3d9a0db Mon Sep 17 00:00:00 2001 From: Yong Tang <yong.tang.github@outlook.com> Date: Thu, 25 Jul 2019 13:20:23 -0700 Subject: [PATCH] Update CONTRIBUTING.md (#3046) Signed-off-by: Yong Tang <yong.tang.github@outlook.com> --- CONTRIBUTING.md | 6 +++++- README.md | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb3801347..18bd4a62b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,11 +29,15 @@ tests to assert your change is working properly and is thoroughly covered. 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. -If so, you may open either an issue or a pull request for discussion and feedback. +Please also check for existing pull requests to see if someone is already working on this. We want to avoid duplication of effort. + +If the proposal is new and no one has opened pull request yet, you may open either an issue or a pull request for discussion and feedback. 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. +**If someone already opened a pull request, but you think the pull request has stalled and you would like to open another pull request for the same or similar feature, get some of the maintainers (see [OWNERS](OWNERS)) involved to resolve the situation and move things forward.** + If possible make a pull request as small as possible, or submit multiple pull request to complete a feature. Smaller means: easier to understand and review. This in turn means things can be merged faster. diff --git a/README.md b/README.md index d881401c4..78c02ed55 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,10 @@ More resources can be found: - Twitter: [@corednsio](https://twitter.com/corednsio) - Mailing list/group: <coredns-discuss@googlegroups.com> (not very active) +## Contribution guidelines + +If you want to contribute to CoreDNS, be sure to review the [contribution guidelines](CONTRIBUTING.md). + ## Deployment Examples for deployment via systemd and other use cases can be found in the [deployment