Skip to content

Commit

Permalink
README: Replace local contrib docs with a CONTRIBUTING.md link
Browse files Browse the repository at this point in the history 
CONTRIBUTING.md (which we got from project-template in be21fe9, *:
Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same
space.  Dropping the contrib docs from the README (and instead linking
to CONTRIBUTING.md) keeps us DRY (vs. having the content in each
location), gets us the GitHub contributing UI improvements [1]
(vs. having the content only in the README), keeps the information
discoverable (vs. having the content only in CONTRIBUTING and not
linking from the README), and gives us more space in the README to
talk about the project itself (contributing docs are only useful for a
subset of README readers).

I've copy/pasted the CONTRIBUTING.md content for issues and the
mailing list into the README at Stephen's request [2].  Personally I
don't have a problem with requiring readers to click through to
CONTRIBUTING to get this information, but I'm not a maintainer.  I am
slightly concerned that the copy/pasted discussion channel information
is even further from the security-disclosure section (for a paranoid
approach, see [3]), but I'll leave addressing that or not up to the
maintainers as well.

[1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
[2]: opencontainers#9 (comment)
[3]: opencontainers/project-template#57

Signed-off-by: W. Trevor King <[email protected]>
  • Loading branch information
@wking
wking committed Apr 11, 2018
1 parent 91d6d84 commit 2632b29
Showing 1 changed file with 7 additions and 108 deletions.
115 changes: 7 additions & 108 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,116 +24,15 @@ Following sections give context for aspects of this specification:

## Contributing

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).
See [our contribution documentation](CONTRIBUTING.md).
Development happens on GitHub.
[Issues][issues] are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).

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.
### Mailing list

### Discuss your design

The project welcomes submissions, but please let everyone know what you are working on.

Before undertaking a nontrivial change to this specification, send mail to the [mailing list](#mailing-list) to discuss what you plan to do.
This gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.
It also guarantees that the design is sound before code is written; a GitHub pull-request is not the place for high-level discussions.

Typos and grammatical errors can go straight to a pull-request.
When in doubt, start on the [mailing-list](#mailing-list).

### Meetings

The contributors and maintainers of all OCI projects have monthly meetings at 2:00 PM (USA Pacific) on the first Wednesday of every month.
There is an [iCalendar][rfc5545] format for the meetings [here](https://github.com/opencontainers/runtime-spec/blob/master/meeting.ics).
Everyone is welcome to participate via [UberConference web][uberconference] or audio-only: +1 415 968 0849 (no PIN needed).
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.
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].

### Mailing List

You can subscribe and join the mailing list on [Google Groups][dev-list].

### IRC

OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).

### Git commit

#### Sign your work

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.
The rules are pretty simple: if you can certify the below (from http://developercertificate.org):

```
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```

then you just add a line to every git commit message:

Signed-off-by: Joe Smith <[email protected]>

using your real name (sorry, no pseudonyms or anonymous contributions.)

You can add the sign off when creating the git commit via `git commit -s`.

#### Commit Style

Simple house-keeping for clean git history.
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].

1. Separate the subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
* If there was important/useful/essential conversation or information, copy or include a reference
8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
You can subscribe and browse the mailing list on [Google Groups][mailing-list].

[charter]: https://www.opencontainers.org/about/governance
[code-of-conduct]: https://github.com/opencontainers/tob/blob/master/code-of-conduct.md
[dev-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
[how-to-git-commit]: http://chris.beams.io/posts/git-commit
[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/
[iso-week]: https://en.wikipedia.org/wiki/ISO_week_date#Calculating_the_week_number_of_a_given_date
[minutes]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/
[oci]: https://www.opencontainers.org
[rfc5545]: https://tools.ietf.org/html/rfc5545
[runtime-wiki]: https://github.com/opencontainers/runtime-spec/wiki
[uberconference]: https://www.uberconference.com/opencontainers

[git-commit.1]: http://git-scm.com/docs/git-commit
[issues]: https://github.com/opencontainers/distribution-spec/issues
[mailing-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev

0 comments on commit 2632b29

Please sign in to comment.