Skip to content

Commit 6c7833a

Browse files
authored
Merge branch 'master' into contributing-no-docs-readme
2 parents b6707eb + 0105945 commit 6c7833a

File tree

2 files changed

+47
-9
lines changed

2 files changed

+47
-9
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,31 @@
1-
## Contribution Guidelines
1+
# Contribution Guidelines
2+
3+
Development happens on GitHub.
4+
Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
5+
6+
The content of this repository is licensed under the [Apache License, Version 2.0](LICENSE).
7+
8+
## Code of Conduct
9+
10+
Participation in the Open Container community is governed by [Open Container Code of Conduct][code-of-conduct].
11+
12+
## Meetings
13+
14+
The contributors and maintainers of all OCI projects have monthly meetings at 2:00 PM (USA Pacific) on the first Wednesday of every month.
15+
There is an [iCalendar][rfc5545] format for the meetings [here][meeting.ics].
16+
Everyone is welcome to participate via [UberConference web][UberConference] or audio-only: +1 415 968 0849 (no PIN needed).
17+
An initial agenda will be posted to the [mailing list](#mailing-list) in the week before each meeting, and everyone is welcome to propose additional topics or suggest other agenda alterations there.
18+
Minutes from past meetings are archived [here][minutes].
19+
20+
## Mailing list
21+
22+
You can subscribe and browse the mailing list on [Google Groups][mailing-list].
23+
24+
## IRC
25+
26+
OCI discussion happens on #opencontainers on [Freenode][] ([logs][irc-logs]).
27+
28+
## Git
229

330
### Security issues
431

@@ -21,12 +48,11 @@ We're trying very hard to keep the project lean and focused. We don't want it
2148
to do everything for everybody. This means that we might decide against
2249
incorporating a new feature.
2350

24-
2551
### Conventions
2652

2753
Fork the repo and make changes on your fork in a feature branch.
2854
For larger bugs and enhancements, consider filing a leader issue or mailing-list thread for discussion that is independent of the implementation.
29-
Small changes or changes that have been discussed on the project mailing list may be submitted without a leader issue.
55+
Small changes or changes that have been discussed on the [project mailing list](#mailing-list) may be submitted without a leader issue.
3056

3157
If the project has a test suite, submit unit tests for your changes. Take a
3258
look at existing tests for inspiration. Run the full test suite on your branch
@@ -36,10 +62,6 @@ Update the documentation when creating or modifying features. Test
3662
your documentation changes for clarity, concision, and correctness, as
3763
well as a clean documentation build.
3864

39-
Write clean code. Universally formatted code promotes ease of writing, reading,
40-
and maintenance. Always run `gofmt -s -w file.go` on each changed file before
41-
committing your changes. Most editors have plugins that do this automatically.
42-
4365
Pull requests descriptions should be as clear as possible and include a
4466
reference to all the issues that they address.
4567

@@ -67,8 +89,7 @@ or `Fixes #XXX`, which will automatically close the issue when merged.
6789
The sign-off is a simple line at the end of the explanation for the
6890
patch, which certifies that you wrote it or otherwise have the right to
6991
pass it on as an open-source patch. The rules are pretty simple: if you
70-
can certify the below (from
71-
[developercertificate.org](http://developercertificate.org/)):
92+
can certify the below (from [developercertificate.org][]):
7293

7394
```
7495
Developer Certificate of Origin
@@ -117,3 +138,12 @@ then you just add a line to every git commit message:
117138
using your real name (sorry, no pseudonyms or anonymous contributions.)
118139

119140
You can add the sign off when creating the git commit via `git commit -s`.
141+
142+
[code-of-conduct]: https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md
143+
[developercertificate.org]: http://developercertificate.org/
144+
[Freenode]: https://freenode.net/
145+
[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/
146+
[mailing-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
147+
[meeting.ics]: https://github.com/opencontainers/runtime-spec/blob/master/meeting.ics
148+
[minutes]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/
149+
[UberConference]: https://www.uberconference.com/opencontainers

MAINTAINERS

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
This meta-project is maintained by the union of MAINTAINERS for all OCI Projects [1].
2+
3+
Other OCI Projects should list one maintainer per line, with a name, email address, and GitHub username:
4+
5+
Random J Developer <[email protected]> (@RandomJDeveloperExample)
6+
A. U. Thor <[email protected]> (@AUThorExample)
7+
8+
[1]: https://github.com/opencontainers/

0 commit comments

Comments
 (0)