Skip to content

Commit f4f0ac0

Browse files
authored
Merge pull request #9 from wking/drop-readme-contrib-docs
README: Replace local contrib docs with a CONTRIBUTING.md link
2 parents 8e29a82 + fa939cc commit f4f0ac0

File tree

1 file changed

+8
-107
lines changed

1 file changed

+8
-107
lines changed

README.md

Lines changed: 8 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -24,116 +24,17 @@ Following sections give context for aspects of this specification:
2424

2525
## Contributing
2626

27-
Development happens on GitHub for the spec. Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](https://github.com/opencontainers/distribution-spec#mailing-list).
27+
See [our contribution documentation](CONTRIBUTING.md).
2828

29-
The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](https://github.com/opencontainers/distribution-spec/blob/master/LICENSE) file.
29+
Development happens on GitHub.
30+
Responsible disclosure for security issues is discussed [here](CONTRIBUTING.md#security-issues).
31+
[Issues][issues] are used for non-security bugs and actionable items; longer discussions can happen on the [mailing list](#mailing-list).
3032

31-
### Discuss your design
33+
### Mailing list
3234

33-
The project welcomes submissions, but please let everyone know what you are working on.
34-
35-
Before undertaking a nontrivial change to this specification, send mail to the [mailing list](#mailing-list) to discuss what you plan to do.
36-
This gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.
37-
It also guarantees that the design is sound before code is written; a GitHub pull-request is not the place for high-level discussions.
38-
39-
Typos and grammatical errors can go straight to a pull-request.
40-
When in doubt, start on the [mailing-list](#mailing-list).
41-
42-
### Meetings
43-
44-
The contributors and maintainers of all OCI projects have monthly meetings at 2:00 PM (USA Pacific) on the first Wednesday of every month.
45-
There is an [iCalendar][rfc5545] format for the meetings [here](https://github.com/opencontainers/runtime-spec/blob/master/meeting.ics).
46-
Everyone is welcome to participate via [UberConference web][uberconference] or audio-only: +1 415 968 0849 (no PIN needed).
47-
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.
48-
Minutes are posted to the [mailing list](#mailing-list) and minutes from past calls are archived [here][minutes], with minutes from especially old meetings (September 2015 and earlier) archived [here][runtime-wiki].
49-
50-
### Mailing List
51-
52-
You can subscribe and join the mailing list on [Google Groups][dev-list].
53-
54-
### IRC
55-
56-
OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).
57-
58-
### Git commit
59-
60-
#### Sign your work
61-
62-
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.
63-
The rules are pretty simple: if you can certify the below (from http://developercertificate.org):
64-
65-
```
66-
Developer Certificate of Origin
67-
Version 1.1
68-
69-
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
70-
660 York Street, Suite 102,
71-
San Francisco, CA 94110 USA
72-
73-
Everyone is permitted to copy and distribute verbatim copies of this
74-
license document, but changing it is not allowed.
75-
76-
77-
Developer's Certificate of Origin 1.1
78-
79-
By making a contribution to this project, I certify that:
80-
81-
(a) The contribution was created in whole or in part by me and I
82-
have the right to submit it under the open source license
83-
indicated in the file; or
84-
85-
(b) The contribution is based upon previous work that, to the best
86-
of my knowledge, is covered under an appropriate open source
87-
license and I have the right under that license to submit that
88-
work with modifications, whether created in whole or in part
89-
by me, under the same open source license (unless I am
90-
permitted to submit under a different license), as indicated
91-
in the file; or
92-
93-
(c) The contribution was provided directly to me by some other
94-
person who certified (a), (b) or (c) and I have not modified
95-
it.
96-
97-
(d) I understand and agree that this project and the contribution
98-
are public and that a record of the contribution (including all
99-
personal information I submit with it, including my sign-off) is
100-
maintained indefinitely and may be redistributed consistent with
101-
this project or the open source license(s) involved.
102-
```
103-
104-
then you just add a line to every git commit message:
105-
106-
Signed-off-by: Joe Smith <[email protected]>
107-
108-
using your real name (sorry, no pseudonyms or anonymous contributions.)
109-
110-
You can add the sign off when creating the git commit via `git commit -s`.
111-
112-
#### Commit Style
113-
114-
Simple house-keeping for clean git history.
115-
Read more on [How to Write a Git Commit Message][how-to-git-commit] or the Discussion section of [git-commit(1)][git-commit.1].
116-
117-
1. Separate the subject from body with a blank line
118-
2. Limit the subject line to 50 characters
119-
3. Capitalize the subject line
120-
4. Do not end the subject line with a period
121-
5. Use the imperative mood in the subject line
122-
6. Wrap the body at 72 characters
123-
7. Use the body to explain what and why vs. how
124-
* If there was important/useful/essential conversation or information, copy or include a reference
125-
8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
35+
You can subscribe and browse the mailing list on [Google Groups][mailing-list].
12636

12737
[charter]: https://www.opencontainers.org/about/governance
12838
[code-of-conduct]: https://github.com/opencontainers/tob/blob/master/code-of-conduct.md
129-
[dev-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
130-
[how-to-git-commit]: http://chris.beams.io/posts/git-commit
131-
[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/
132-
[iso-week]: https://en.wikipedia.org/wiki/ISO_week_date#Calculating_the_week_number_of_a_given_date
133-
[minutes]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/
134-
[oci]: https://www.opencontainers.org
135-
[rfc5545]: https://tools.ietf.org/html/rfc5545
136-
[runtime-wiki]: https://github.com/opencontainers/runtime-spec/wiki
137-
[uberconference]: https://www.uberconference.com/opencontainers
138-
139-
[git-commit.1]: http://git-scm.com/docs/git-commit
39+
[issues]: https://github.com/opencontainers/distribution-spec/issues
40+
[mailing-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev

0 commit comments

Comments
 (0)