|
| 1 | +# CoreDNS Governance |
| 2 | + |
| 3 | +## Principles |
| 4 | + |
| 5 | +The CoreDNS community adheres to the following principles: |
| 6 | + |
| 7 | +- Open: CoreDNS is open source, advertised on [our website](https://coredns.io/community). |
| 8 | +- Welcoming and respectful: See [Code of Conduct](CODE-OF-CONDUCT.md). |
| 9 | +- Transparent and accessible: Changes to the CoreDNS organization, CoreDNS code repositories, and CNCF related activities (e.g. level, involvement, etc) are done in public. |
| 10 | +- Merit: Ideas and contributions are accepted according to their technical merit and alignment with |
| 11 | + project objectives, scope, and design principles. |
| 12 | + |
| 13 | +## Project Lead |
| 14 | + |
| 15 | +The CoreDNS project has a project lead. |
| 16 | + |
| 17 | +A project lead in CoreDNS is |
| 18 | +a single person that has a final say in any decision concerning the CoreDNS project. |
| 19 | + |
| 20 | +The term of the project lead is one year, with no term limit restriction. |
| 21 | + |
| 22 | +The project lead is elected by CoreDNS maintainers |
| 23 | +according to an individual's technical merit to CoreDNS project. |
| 24 | + |
| 25 | +The current project lead is identified in the top level [OWNERS](OWNERS) file with the string |
| 26 | +`project lead` and the term behind the name. |
| 27 | + |
| 28 | + |
| 29 | +## Expectations from Maintainers |
| 30 | + |
| 31 | +Every one carries water... |
| 32 | + |
| 33 | +Making a community work requires input/effort from everyone. Maintainers should actively |
| 34 | +participate in Pull Request reviews. Maintainers are expected to respond to assigned Pull Requests |
| 35 | +in a *reasonable* time frame, either providing insights, or assign the Pull Requests to other |
| 36 | +maintainers. |
| 37 | + |
| 38 | +Every Maintainer is listed in the top-level [OWNERS](https://github.com/coredns/coredns/blob/master/OWNERS) |
| 39 | +file, with their Github handle and a possibly obfuscated email address. Everyone in the |
| 40 | +`approvers` list is a Maintainer. |
| 41 | + |
| 42 | +A Maintainer is also listed in a plugin specific OWNERS file. |
| 43 | + |
| 44 | +A Maintainer should be a member of `[email protected]`, although this is not a hard requirement. |
| 45 | + |
| 46 | +## Becoming a Maintainer |
| 47 | + |
| 48 | +On successful merge of a significant pull request any current maintainer can reach |
| 49 | +to the author behind the pull request and ask them if they are willing to become a CoreDNS |
| 50 | +maintainer. The email of the new maintainer invitation should be cc'ed to `[email protected]` |
| 51 | +as part of the process. |
| 52 | + |
| 53 | +## Changes in Maintainership |
| 54 | + |
| 55 | +If a Maintainer feels she/he can not fulfill the "Expectations from Maintainers", they are free to |
| 56 | +step down. |
| 57 | + |
| 58 | +The CoreDNS organization will never forcefully remove a current Maintainer, unless a maintainer |
| 59 | +fails to meet the principles of CoreDNS community, |
| 60 | +or adhere to the [Code of Conduct](CODE-OF-CONDUCT.md). |
| 61 | + |
| 62 | +## Changes in Project Lead |
| 63 | + |
| 64 | +Changes in project lead or term is initiated by opening a github PR. |
| 65 | + |
| 66 | +Anyone from CoreDNS community can vote on the PR with either +1 or -1. |
| 67 | + |
| 68 | +Only the following votes are binding: |
| 69 | +1) Any maintainer that has been listed in the top-level [OWNERS](OWNERS) file before the PR is opened. |
| 70 | +2) Any maintainer from an organization may cast the vote for that organization. However, no organization |
| 71 | +should have more binding votes than 1/5 of the total number of maintainers defined in 1). |
| 72 | + |
| 73 | +The PR should only be opened no earlier than 6 weeks before the end of the project lead's term. |
| 74 | +The PR should be kept open for no less than 4 weeks. The PR can only be merged after the end of the |
| 75 | +last project lead's term, with more +1 than -1 in the binding votes. |
| 76 | + |
| 77 | +When there are conflicting PRs about changes in project lead, the PR with the most binding +1 votes is merged. |
| 78 | + |
| 79 | +The project lead can volunteer to step down. |
| 80 | + |
| 81 | +## Changes in Project Governance |
| 82 | + |
| 83 | +Changes in project governance (GOVERNANCE.md) could be initiated by opening a github PR. |
| 84 | +The PR should only be opened no earlier than 6 weeks before the end of the project lead's term. |
| 85 | +The PR should be kept open for no less than 4 weeks. The PR can only be merged follow the same |
| 86 | +voting process as in `Changes in Project Lead`. |
| 87 | + |
| 88 | +## Decision making process |
| 89 | + |
| 90 | +Decisions are build on consensus between maintainers. |
| 91 | +Proposals and ideas can either be submitted for agreement via a github issue or PR, |
| 92 | +or by sending an email to `[email protected]`. |
| 93 | + |
| 94 | +In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved. |
| 95 | +If a dispute cannot be decided independently, get a third-party maintainer (e.g. a mutual contact with some background |
| 96 | +on the issue, but not involved in the conflict) to intercede. |
| 97 | +If a dispute still cannot be decided, the project lead has the final say to decide an issue. |
| 98 | + |
| 99 | +Decision making process should be transparent to adhere to |
| 100 | +the principles of CoreDNS project. |
| 101 | + |
| 102 | +All proposals, ideas, and decisions by maintainers or the project lead |
| 103 | +should either be part of a github issue or PR, or be sent to `[email protected]`. |
| 104 | + |
| 105 | +## Github Project Administration |
| 106 | + |
| 107 | +The __coredns__ GitHub project maintainers team reflects the list of Maintainers. |
| 108 | + |
| 109 | +## Other Projects |
| 110 | + |
| 111 | +The CoreDNS organization is open to receive new sub-projects under its umbrella. To accept a project |
| 112 | +into the __CoreDNS__ organization, it has to meet the following criteria: |
| 113 | + |
| 114 | +- Must be licensed under the terms of the Apache License v2.0 |
| 115 | +- Must be related to one or more scopes of the CoreDNS ecosystem: |
| 116 | + - CoreDNS project artifacts (website, deployments, CI, etc) |
| 117 | + - External plugins |
| 118 | + - Other DNS related processing |
| 119 | +- Must be supported by a Maintainer not associated or affiliated with the author(s) of the sub-projects |
| 120 | + |
| 121 | +The submission process starts as a Pull Request or Issue on the |
| 122 | +[coredns/coredns](https://github.com/coredns/coredns) repository with the required information |
| 123 | +mentioned above. Once a project is accepted, it's considered a __CNCF sub-project under the umbrella |
| 124 | +of CoreDNS__. |
| 125 | + |
| 126 | +## New Plugins |
| 127 | + |
| 128 | +The CoreDNS is open to receive new plugins as part of the CoreDNS repo. The submission process |
| 129 | +is the same as a Pull Request submission. Unlike small Pull Requests though, a new plugin submission |
| 130 | +should only be approved by a maintainer not associated or affiliated with the author(s) of the |
| 131 | +plugin. |
| 132 | + |
| 133 | +## CoreDNS and CNCF |
| 134 | + |
| 135 | +CoreDNS is a CNCF project. As such, CoreDNS might be involved in CNCF (or other CNCF projects) related |
| 136 | +marketing, events, or activities. Any maintainer could help driving the CoreDNS involvement, as long as |
| 137 | +she/he sends email to `[email protected]` (or create a GitHub Pull Request) to call for participation |
| 138 | +from other maintainers. The `Call for Participation` should be kept open for no less than a week if time |
| 139 | +permits, or a _reasonable_ time frame to allow maintainers to have a chance to volunteer. |
| 140 | + |
| 141 | +## Code of Conduct |
| 142 | + |
| 143 | +The [CoreDNS Code of Conduct](CODE-OF-CONDUCT.md) is aligned with the CNCF Code of Conduct. |
| 144 | + |
| 145 | +## Credits |
| 146 | + |
| 147 | +Sections of this documents have been borrowed from [Fluentd](https://github.com/fluent/fluentd/blob/master/GOVERNANCE.md) and [Envoy](https://github.com/envoyproxy/envoy/blob/master/GOVERNANCE.md) projects. |
0 commit comments