Skip to content

Commit c3b5b44

Browse files
committed
CONTRIBUTING: Lead off with the security section
This reduces the chances that a skimmer reads "Issues are used for bugs..." and files an issue without scrolling down to see the security section. I've also added links back to the security section from the all other paragraphs that suggest using other channels (issues, pull requests, IRC), so that no matter which anchor a skimmer starts at, they cannot miss the fact that we have a special disclosure procedure for security issues. If we are confident that readers interested in submitting a security issue will not start at a mid-document anchor without reading the beginning of this file, we could drop some or all of these back-refs. Also adjust the lines I touch to use one line per sentence, since that's the standard in other OCI Projects (like the runtime spec [1]). [1]: https://github.com/opencontainers/runtime-spec/blob/v1.0.1/style.md#one-sentence-per-line Signed-off-by: W. Trevor King <[email protected]>
1 parent bb03453 commit c3b5b44

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Contribution Guidelines
22

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).
3+
## Security issues
54

6-
The content of this repository is licensed under the [Apache License, Version 2.0](LICENSE).
5+
If you are reporting a security issue, *do not* create an issue or file a pull request on GitHub.
6+
Instead, disclose the issue responsibly by sending an email to [[email protected]](mailto:[email protected]) (which is inhabited only by the maintainers of the various OCI projects).
77

88
## Code of Conduct
99

1010
Participation in the Open Container community is governed by [Open Container Code of Conduct][code-of-conduct].
1111

12+
## Discussion
13+
14+
Development happens on GitHub.
15+
Issues are used for non-security bugs and actionable items; longer discussions can happen on the [mailing list](#mailing-list).
16+
Responsible disclosure for security issues is discussed [above](#security-issues).
17+
1218
## Meetings
1319

1420
The contributors and maintainers of all OCI projects have monthly meetings at 2:00 PM (USA Pacific) on the first Wednesday of every month.
@@ -20,25 +26,24 @@ Minutes from past meetings are archived [here][minutes].
2026
## Mailing list
2127

2228
You can subscribe and browse the mailing list on [Google Groups][mailing-list].
29+
Responsible disclosure for security issues is discussed [above](#security-issues).
2330

2431
## IRC
2532

26-
OCI discussion happens on #opencontainers on [Freenode][] ([logs][irc-logs]).
33+
Non-security OCI discussion happens on #opencontainers on [Freenode][] ([logs][irc-logs]).
34+
Responsible disclosure for security issues is discussed [above](#security-issues).
2735

2836
## Git
2937

30-
### Security issues
31-
32-
If you are reporting a security issue, do not create an issue or file a pull
33-
request on GitHub. Instead, disclose the issue responsibly by sending an email
34-
to [email protected] (which is inhabited only by the maintainers of
35-
the various OCI projects).
38+
The content of this repository is licensed under the [Apache License, Version 2.0](LICENSE).
3639

3740
### Pull requests are always welcome
3841

39-
We are always thrilled to receive pull requests, and do our best to
40-
process them as fast as possible. Not sure if that typo is worth a pull
41-
request? Do it! We will appreciate it.
42+
We are always thrilled to receive pull requests for non-security changes, and do our best to process them as fast as possible.
43+
Not sure if that typo is worth a pull request?
44+
Do it!
45+
We will appreciate it.
46+
Responsible disclosure for security issues is discussed [above](#security-issues).
4247

4348
If your pull request is not accepted on the first try, don't be
4449
discouraged! If there's a problem with the implementation, hopefully you
@@ -51,8 +56,9 @@ incorporating a new feature.
5156
### Conventions
5257

5358
Fork the repo and make changes on your fork in a feature branch.
54-
For larger bugs and enhancements, consider filing a leader issue or mailing-list thread for discussion that is independent of the implementation.
59+
For larger non-security bugs and enhancements, consider filing a leader issue or mailing-list thread for discussion that is independent of the implementation.
5560
Small changes or changes that have been discussed on the [project mailing list](#mailing-list) may be submitted without a leader issue.
61+
Responsible disclosure for security issues is discussed [above](#security-issues).
5662

5763
If the project has a test suite, submit unit tests for your changes. Take a
5864
look at existing tests for inspiration. Run the full test suite on your branch

0 commit comments

Comments
 (0)