Update CONTRIBUTING.md with links to sections and `Proposal:` process.
| ... | ... |
@@ -4,6 +4,38 @@ Want to hack on Docker? Awesome! Here are instructions to get you |
| 4 | 4 |
started. They are probably not perfect, please let us know if anything |
| 5 | 5 |
feels wrong or incomplete. |
| 6 | 6 |
|
| 7 |
+## Topics |
|
| 8 |
+ |
|
| 9 |
+* [Security Reports](#security-reports) |
|
| 10 |
+* [Design and Cleanup Proposals](#design-and-cleanup-proposals) |
|
| 11 |
+* [Reporting Issues](#reporting-issues) |
|
| 12 |
+* [Build Environment](#build-environment) |
|
| 13 |
+* [Contribution Guidelines](#contribution-guidelines) |
|
| 14 |
+ |
|
| 15 |
+## Security Reports |
|
| 16 |
+ |
|
| 17 |
+Please **DO NOT** file an issue for security related issues. Please send your |
|
| 18 |
+reports to [security@docker.com](mailto:security@docker.com) instead. |
|
| 19 |
+ |
|
| 20 |
+## Design and Cleanup Proposals |
|
| 21 |
+ |
|
| 22 |
+When considering a design proposal, we are looking for: |
|
| 23 |
+ |
|
| 24 |
+* A description of the problem this design proposal solves |
|
| 25 |
+* An issue -- not a pull request -- that describes what you will take action on |
|
| 26 |
+ * Please prefix your issue with `Proposal:` in the title |
|
| 27 |
+* Please review [the existing Proposals](https://github.com/dotcloud/docker/issues?direction=asc&labels=Proposal&page=1&sort=created&state=open) |
|
| 28 |
+ before reporting a new issue. You can always pair with someone if you both |
|
| 29 |
+ have the same idea. |
|
| 30 |
+ |
|
| 31 |
+When considering a cleanup task, we are looking for: |
|
| 32 |
+ |
|
| 33 |
+* A description of the refactors made |
|
| 34 |
+ * Please note any logic changes if necessary |
|
| 35 |
+* A pull request with the code |
|
| 36 |
+ * Please prefix your PR's title with `Cleanup:` so we can quickly address it. |
|
| 37 |
+ * Your pull request must remain up to date with master, so rebase as necessary. |
|
| 38 |
+ |
|
| 7 | 39 |
## Reporting Issues |
| 8 | 40 |
|
| 9 | 41 |
When reporting [issues](https://github.com/docker/docker/issues) on |