Skip to content

Commit 30dfd9a

Browse files
author
Mrunal Patel
committed
Merge pull request #56 from opencontainers/update-contributing-guidelines
Update contributing guidelines and add maintainer guidelines
2 parents 8ab86b6 + bfebb7f commit 30dfd9a

File tree

2 files changed

+189
-3
lines changed

2 files changed

+189
-3
lines changed

‎CONTRIBUTING.md‎

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,72 @@
1-
# Sign your work
1+
## Contribution Guidelines
22

3-
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.
4-
The rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)):
3+
### Pull requests are always welcome
4+
5+
We are always thrilled to receive pull requests, and do our best to
6+
process them as fast as possible. Not sure if that typo is worth a pull
7+
request? Do it! We will appreciate it.
8+
9+
If your pull request is not accepted on the first try, don't be
10+
discouraged! If there's a problem with the implementation, hopefully you
11+
received feedback on what to improve.
12+
13+
We're trying very hard to keep the project lean and focused. We don't want it
14+
to do everything for everybody. This means that we might decide against
15+
incorporating a new feature.
16+
17+
18+
### Conventions
19+
20+
Fork the repo and make changes on your fork in a feature branch:
21+
22+
- If it's a bugfix branch, name it XXX-something where XXX is the number of the
23+
issue
24+
- If it's a feature branch, create an enhancement issue to announce your
25+
intentions, and name it XXX-something where XXX is the number of the issue.
26+
27+
Submit unit tests for your changes. Go has a great test framework built in; use
28+
it! Take a look at existing tests for inspiration. Run the full test suite on
29+
your branch before submitting a pull request.
30+
31+
Update the documentation when creating or modifying features. Test
32+
your documentation changes for clarity, concision, and correctness, as
33+
well as a clean documentation build. See ``docs/README.md`` for more
34+
information on building the docs and how docs get released.
35+
36+
Write clean code. Universally formatted code promotes ease of writing, reading,
37+
and maintenance. Always run `gofmt -s -w file.go` on each changed file before
38+
committing your changes. Most editors have plugins that do this automatically.
39+
40+
Pull requests descriptions should be as clear as possible and include a
41+
reference to all the issues that they address.
42+
43+
Pull requests must not contain commits from other users or branches.
44+
45+
Commit messages must start with a capitalized and short summary (max. 50
46+
chars) written in the imperative, followed by an optional, more detailed
47+
explanatory text which is separated from the summary by an empty line.
48+
49+
Code review comments may be added to your pull request. Discuss, then make the
50+
suggested modifications and push additional commits to your feature branch. Be
51+
sure to post a comment after pushing. The new commits will show up in the pull
52+
request automatically, but the reviewers will not be notified unless you
53+
comment.
54+
55+
Before the pull request is merged, make sure that you squash your commits into
56+
logical units of work using `git rebase -i` and `git push -f`. After every
57+
commit the test suite should be passing. Include documentation changes in the
58+
same commit so that a revert would remove all traces of the feature or fix.
59+
60+
Commits that fix or close an issue should include a reference like `Closes #XXX`
61+
or `Fixes #XXX`, which will automatically close the issue when merged.
62+
63+
### Sign your work
64+
65+
The sign-off is a simple line at the end of the explanation for the
66+
patch, which certifies that you wrote it or otherwise have the right to
67+
pass it on as an open-source patch. The rules are pretty simple: if you
68+
can certify the below (from
69+
[developercertificate.org](http://developercertificate.org/)):
570

671
```
772
Developer Certificate of Origin

‎MAINTAINERS_GUIDE.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
## Introduction
2+
3+
Dear maintainer. Thank you for investing the time and energy to help
4+
make this project as useful as possible. Maintaining a project is difficult,
5+
sometimes unrewarding work. Sure, you will get to contribute cool
6+
features to the project. But most of your time will be spent reviewing,
7+
cleaning up, documenting, answering questions, justifying design
8+
decisions - while everyone has all the fun! But remember - the quality
9+
of the maintainers work is what distinguishes the good projects from the
10+
great. So please be proud of your work, even the unglamourous parts,
11+
and encourage a culture of appreciation and respect for *every* aspect
12+
of improving the project - not just the hot new features.
13+
14+
This document is a manual for maintainers old and new. It explains what
15+
is expected of maintainers, how they should work, and what tools are
16+
available to them.
17+
18+
This is a living document - if you see something out of date or missing,
19+
speak up!
20+
21+
## What are a maintainer's responsibility?
22+
23+
It is every maintainer's responsibility to:
24+
25+
* 1) Expose a clear roadmap for improving their component.
26+
* 2) Deliver prompt feedback and decisions on pull requests.
27+
* 3) Be available to anyone with questions, bug reports, criticism etc.
28+
on their component. This includes IRC and GitHub issues and pull requests.
29+
* 4) Make sure their component respects the philosophy, design and
30+
roadmap of the project.
31+
32+
## How are decisions made?
33+
34+
Short answer: with pull requests to the project repository.
35+
36+
This project is an open-source project with an open design philosophy. This
37+
means that the repository is the source of truth for EVERY aspect of the
38+
project, including its philosophy, design, roadmap and APIs. *If it's
39+
part of the project, it's in the repo. It's in the repo, it's part of
40+
the project.*
41+
42+
As a result, all decisions can be expressed as changes to the
43+
repository. An implementation change is a change to the source code. An
44+
API change is a change to the API specification. A philosophy change is
45+
a change to the philosophy manifesto. And so on.
46+
47+
All decisions affecting this project, big and small, follow the same 3 steps:
48+
49+
* Step 1: Open a pull request. Anyone can do this.
50+
51+
* Step 2: Discuss the pull request. Anyone can do this.
52+
53+
* Step 3: Accept (`LGTM`) or refuse a pull request. The relevant maintainers do
54+
this (see below "Who decides what?")
55+
56+
### I'm a maintainer, should I make pull requests too?
57+
58+
Yes. Nobody should ever push to master directly. All changes should be
59+
made through a pull request.
60+
61+
## Who decides what?
62+
63+
All decisions are pull requests, and the relevant maintainers make
64+
decisions by accepting or refusing the pull request. Review and acceptance
65+
by anyone is denoted by adding a comment in the pull request: `LGTM`.
66+
However, only currently listed `MAINTAINERS` are counted towards the required
67+
two LGTMs.
68+
69+
Overall the maintainer system works because of mutual respect across the
70+
maintainers of the project. The maintainers trust one another to make decisions
71+
in the best interests of the project. Sometimes maintainers can disagree and
72+
this is part of a healthy project to represent the point of views of various people.
73+
In the case where maintainers cannot find agreement on a specific change the
74+
role of a Chief Maintainer comes into play.
75+
76+
The Chief Maintainer for the project is responsible for overall architecture
77+
of the project to maintain conceptual integrity. Large decisions and
78+
architecture changes should be reviewed by the chief maintainer.
79+
The current chief maintainer for the project is the first person listed
80+
in the MAINTAINERS file.
81+
82+
Even though the maintainer system is built on trust, if there is a conflict
83+
with the chief maintainer on a decision, their decision can be challenged
84+
and brought to the technical oversight board if two-thirds of the
85+
maintainers vote for an appeal. It is expected that this would be a
86+
very exceptional event.
87+
88+
89+
### How are maintainers added?
90+
91+
The best maintainers have a vested interest in the project. Maintainers
92+
are first and foremost contributors that have shown they are committed to
93+
the long term success of the project. Contributors wanting to become
94+
maintainers are expected to be deeply involved in contributing code,
95+
pull request review, and triage of issues in the project for more than two months.
96+
97+
Just contributing does not make you a maintainer, it is about building trust
98+
with the current maintainers of the project and being a person that they can
99+
depend on and trust to make decisions in the best interest of the project. The
100+
final vote to add a new maintainer should be approved by over 66% of the current
101+
maintainers with the chief maintainer having veto power. In case of a veto,
102+
conflict resolution rules expressed above apply. The voting period is
103+
five business days on the Pull Request to add the new maintainer.
104+
105+
106+
### What is expected of maintainers?
107+
108+
Part of a healthy project is to have active maintainers to support the community
109+
in contributions and perform tasks to keep the project running. Maintainers are
110+
expected to be able to respond in a timely manner if their help is required on specific
111+
issues where they are pinged. Being a maintainer is a time consuming commitment and should
112+
not be taken lightly.
113+
114+
When a maintainer is unable to perform the required duties they can be removed with
115+
a vote by 66% of the current maintainers with the chief maintainer having veto power.
116+
The voting period is ten business days. Issues related to a maintainer's performance should
117+
be discussed with them among the other maintainers so that they are not surprised by
118+
a pull request removing them.
119+
120+
121+

0 commit comments

Comments
 (0)