Skip to content

Commit 1014b30

Browse files
committed
README.md: contribution about discussion
Leaning on aspects of golang's contribution (https://golang.org/doc/contribute.html) Signed-off-by: Vincent Batts <vbatts@redhat.com>
1 parent da9240a commit 1014b30

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,21 +54,34 @@ With Standard Containers we can put an end to that embarrassment, by making INDU
5454

5555
# Contributing
5656

57-
Development happens on github for the spec. Issues are used for bugs and actionable items and longer
58-
discussions can happen on the mailing list. You can subscribe and join the mailing list on
59-
[google groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).
57+
Development happens on github for the spec.
58+
Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
6059

61-
The specification and code is licensed under the Apache 2.0 license found in
62-
the `LICENSE` file of this repository.
60+
The specification and code is licensed under the Apache 2.0 license found in the `LICENSE` file of this repository.
61+
62+
## Mailing List
63+
64+
You can subscribe and join the mailing list on [google groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).
6365

6466
## Weekly Call
6567

6668
The contributors and maintainers of the project have a weekly meeting Wednesdays at 10:00 AM PST.
6769
The link to the call will be posted on the mailing list each week along with set topics for discussion.
6870
Everyone is welcome to participate in the call, although there can only be speaking members on the Google Hangout.
6971
Participants who don't get a speaking slot can watch the live broadcast on [this YouTube channel][youtube] and post feedback and questions on [the IRC channel](#irc).
70-
Everyone is welcome to propose additional topics, suggest other agenda alterations, or request a speaking slot via the mailing list.
71-
Minutes for the call will be posted to the mailing list for those who are unable to join the call.
72+
Everyone is welcome to propose additional topics, suggest other agenda alterations, or request a speaking slot via the [mailing list](#mailing-list).
73+
Minutes for the call will be posted to the [mailing list](#mailing-list) for those who are unable to join the call.
74+
75+
## Discuss your design
76+
77+
The project welcomes submissions, but please let everyone know what you are working on.
78+
79+
Before undertaking a not-trivial change to this specification, send mail to the [mailing list](#mailing-list) to discuss what you plan to do.
80+
This gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.
81+
It also guarantees that the design is sound before code is written; a github pull-request is not the place for high-level discussions.
82+
83+
Typos and grammatical errors can go straight to a pull-request.
84+
If there is question, start on the [mailing-list](#mailing-list).
7285

7386
## IRC
7487

0 commit comments

Comments
 (0)