Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

text for governance proposal, rev 4 #2220

Merged
merged 33 commits into from
Nov 12, 2018
Merged
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
bfd6315
- fradt governance - copy from other project.
Sep 17, 2018
7c7bdf8
- adapt governance to CoreDNS project
Sep 20, 2018
0226bd3
- esasy changes based on comments
Sep 24, 2018
03ee44f
- individuals declare if they contribute for an organization/company …
Sep 28, 2018
652ef1f
Add GOVERNANCE doc
miekg Sep 29, 2018
439c235
better
miekg Sep 29, 2018
e1b6a3c
Apply changes from PR 2203
yongtang Oct 20, 2018
1108455
Add decision making process and change in project lead.
yongtang Oct 20, 2018
0ee7f28
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
14b11c9
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
99033c4
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
3aa21cc
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
4430dcc
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
e0368cf
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
cc61223
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
a80247d
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
47aaf82
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
7ad81b5
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
c403327
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
ef7bdce
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
fa8a7f0
Update GOVERNANCE.md
dilyevsky Nov 7, 2018
64616d3
Update based on comment from dilyevsky
yongtang Nov 7, 2018
34b05d0
Add third-party maintainer as part of the decision making process
yongtang Nov 7, 2018
2a8903c
Small fixes
yongtang Nov 7, 2018
0d745cf
Add restrictions to maintainer support for subproject
yongtang Nov 7, 2018
0ae95f1
Add restrictions to maintainer support for new plugins
yongtang Nov 8, 2018
b9cdfb9
New maintainer invitation should be cc'ed to maintainer list
yongtang Nov 8, 2018
3ba0d7c
Small fix
yongtang Nov 8, 2018
e81fc2d
Add CoreDNS and CNCF
yongtang Nov 8, 2018
d25f522
Restrict project lead to one year
yongtang Nov 8, 2018
618fbf9
Add time frame to keep call-for-participation
yongtang Nov 8, 2018
ee552b4
Add `Changes in Project Governance`
yongtang Nov 8, 2018
32090a7
Add time to open pr for changes in lead and goverance
yongtang Nov 8, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
147 changes: 147 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
# CoreDNS Governance

## Principles

The CoreDNS community adheres to the following principles:

- Open: CoreDNS is open source, advertised on [our website](https://coredns.io/community).
- Welcoming and respectful: See [Code of Conduct](CODE-OF-CONDUCT.md).
- Transparent and accessible: Work and collaboration are done in public.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the scope of this? Does it mean that all CoreDNS related discussions should be made known and accessible/open to the public? (e.g. scheduled conference call meetings)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I think just like the way cncf works, everything could be public. For example, cncf toc meetings are publicly joinable.

I do understand there might be some special situations. For example, let's say I find one contributor who has done a lot to coredns. I want to send an invite to the contributor to be a maintainer. Sometimes I may want to send an email to maintainers@coredns.io first to see if there is any objection, before the invitation email to the contributor is out.

This is for curtesy: you really don't want to send an invitation first, then take it back a couple of days later.

I think there are some special scenarios. Though most of the time I think public is not a problem.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would I be violating the principles if I participate in an ad-hoc whiteboard discussion about CoreDNS with a colleague in person without setting up a public video chat (e.g. Zoom). I would hope no, as it would stifle in-person collaboration. But strictly speaking it does violate the principle as written.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think public applies only if there is an impact to coredns project.

I believe in person collaborations does not have any impact to coredns project/repo itself, as it does not change coredns repo or organization.

Participation to cncf could change the coredns project. A PR could also change the coredns repo, but of course a PR is always public.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Participation to cncf could change the coredns project.

Do you mean a change in a CNCF membership level?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe in person collaborations does not have any impact to coredns project/repo itself, as it does not change coredns repo or organization.

Should we instead say:

Suggested change
- Transparent and accessible: Work and collaboration are done in public.
- Transparent and accessible: Changes to the CoreDNS organization and CoreDNS code repositories are done in public.

- Merit: Ideas and contributions are accepted according to their technical merit and alignment with
project objectives, scope, and design principles.

## Project Lead

The CoreDNS project has a project lead.

A project lead in CoreDNS is
a single person that has a final say in any decision concerning the CoreDNS project.

The term of the project lead is one year, with no term limit restriction.

The project lead is elected by CoreDNS maintainers
according to an individual's technical merit to CoreDNS project.

The current project lead is identified in the top level [OWNERS](OWNERS) file with the string
`project lead` and the term behind the name.


## Expectations from Maintainers

Every one carries water...

Making a community work requires input/effort from everyone. Maintainers should actively
participate in Pull Request reviews. Maintainers are expected to respond to assigned Pull Requests
in a *reasonable* time frame, either providing insights, or assign the Pull Requests to other
maintainers.

Every Maintainer is listed in the top-level [OWNERS](https://github.com/coredns/coredns/blob/master/OWNERS)
file, with their Github handle and a possibly obfuscated email address. Everyone in the
`approvers` list is a Maintainer.

A Maintainer is also listed in a plugin specific OWNERS file.

A Maintainer should be a member of `maintainers@coredns.io`, although this is not a hard requirement.

## Becoming a Maintainer

On successful merge of a significant pull request any current maintainer can reach
to the author behind the pull request and ask them if they are willing to become a CoreDNS
maintainer. The email of the new maintainer invitation should be cc'ed to `maintainers@coredns.io`
as part of the process.

## Changes in Maintainership

If a Maintainer feels she/he can not fulfill the "Expectations from Maintainers", they are free to
step down.

The CoreDNS organization will never forcefully remove a current Maintainer, unless a maintainer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does the decision process of removal work? (e.g. Leader decides, maintainers vote).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, never mind. I see below in the decision making process section, it states "... and maintainer membership ..."

fails to meet the principles of CoreDNS community,
or adhere to the [Code of Conduct](CODE-OF-CONDUCT.md).

## Changes in Project Lead

Changes in project lead or term is initiated by opening a github PR.

Anyone from CoreDNS community can vote on the PR with either +1 or -1.

Only the following votes are binding:
1) Any maintainer that has been listed in the top-level [OWNERS](OWNERS) file before the PR is opened.
2) Any maintainer from an organization may cast the vote for that organization. However, no organization
should have more binding votes than 1/5 of the total number of maintainers defined in 1).

The PR should only be opened no earlier than 6 weeks before the end of the project lead's term.
The PR should be kept open for no less than 4 weeks. The PR can only be merged after the end of the
last project lead's term, with more +1 than -1 in the binding votes.

When there are conflicting PRs about changes in project lead, the PR with the most binding +1 votes is merged.

The project lead can volunteer to step down.

## Changes in Project Governance

Changes in project governance (GOVERNANCE.md) could be initiated by opening a github PR.
The PR should only be opened no earlier than 6 weeks before the end of the project lead's term.
The PR should be kept open for no less than 4 weeks. The PR can only be merged follow the same
voting process as in `Changes in Project Lead`.

## Decision making process

Decisions are build on consensus between maintainers.
Proposals and ideas can either be submitted for agreement via a github issue or PR,
or by sending an email to `maintainers@coredns.io`.

In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved.
If a dispute cannot be decided independently, get a third-party maintainer (e.g. a mutual contact with some background
on the issue, but not involved in the conflict) to intercede.
If a dispute still cannot be decided, the project lead has the final say to decide an issue.

Decision making process should be transparent to adhere to
the principles of CoreDNS project.

All proposals, ideas, and decisions by maintainers or the project lead
should either be part of a github issue or PR, or be sent to `maintainers@coredns.io`.

## Github Project Administration

The __coredns__ GitHub project maintainers team reflects the list of Maintainers.

## Other Projects

The CoreDNS organization is open to receive new sub-projects under its umbrella. To accept a project
into the __CoreDNS__ organization, it has to meet the following criteria:

- Must be licensed under the terms of the Apache License v2.0
- Must be related to one or more scopes of the CoreDNS ecosystem:
- CoreDNS project artifacts (website, deployments, CI, etc)
- External plugins
- Other DNS related processing
- Must be supported by a Maintainer not associated or affiliated with the author(s) of the sub-projects

The submission process starts as a Pull Request or Issue on the
[coredns/coredns](https://github.com/coredns/coredns) repository with the required information
mentioned above. Once a project is accepted, it's considered a __CNCF sub-project under the umbrella
of CoreDNS__.

## New Plugins

The CoreDNS is open to receive new plugins as part of the CoreDNS repo. The submission process
is the same as a Pull Request submission. Unlike small Pull Requests though, a new plugin submission
should only be approved by a maintainer not associated or affiliated with the author(s) of the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What precisely is meant by "associated or affiliated"? We are all associated/affiliated via working on CoreDNS.

Does this mean "working for the same company/organization" ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the idea is to not including the affiliation/association through coredns or cncf. Don't know what is the best phase but happy to take any suggestions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about ...

... should only be approved by a maintainer not in the same company/organization as the author(s) ...

plugin.

## CoreDNS and CNCF

CoreDNS is a CNCF project. As such, CoreDNS might be involved in CNCF (or other CNCF projects) related
marketing, events, or activities. Any maintainer could help driving the CoreDNS involvement, as long as
she/he sends email to `maintainers@coredns.io` (or create a GitHub Pull Request) to call for participation
from other maintainers. The `Call for Participation` should be kept open for no less than a week if time
permits, or a _reasonable_ time frame to allow maintainers to have a chance to volunteer.

## Code of Conduct

The [CoreDNS Code of Conduct](CODE-OF-CONDUCT.md) is aligned with the CNCF Code of Conduct.

## Credits

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.