Skip to content

Commit fe7f9c2

Browse files
author
Matthew Fisher
committed
feat(CONTRIBUTING): add design proposal guidelines
ripped straight from https://github.com/docker/docker/blob/master/CONTRIBUTING.md#design-and-cleanup-proposals
1 parent 4be44ac commit fe7f9c2

2 files changed

Lines changed: 20 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,15 @@ This is a rough outline of what a contributor's workflow looks like:
4444

4545
Thanks for your contributions!
4646

47+
### Design Proposals
48+
49+
When considering a design proposal, we are looking for:
50+
51+
- A description of the problem this design proposal solves
52+
- A pull request that modifies the documentation, describing the feature you are proposing
53+
- Prefix your pull request with `Proposal:` in the title
54+
- Please review the existing Proposals before reporting a new one.
55+
4756
### Commit Style Guideline
4857

4958
We follow a rough convention for commit messages borrowed from CoreOS, who borrowed theirs

docs/contributing/standards.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,17 @@ tests are required for all public methods, although the flake8_ tool used by
8383
Deis does not enforce this.
8484

8585

86+
Design Proposals
87+
----------------
88+
89+
When considering a design proposal, we are looking for:
90+
91+
- A description of the problem this design proposal solves
92+
- A pull request that modifies the documentation, describing the feature you are proposing
93+
- Prefix your pull request with ``Proposal:`` in the title
94+
- Please review the existing Proposals before reporting a new one.
95+
96+
8697
.. _commit_style_guide:
8798

8899
Commit Style

0 commit comments

Comments
 (0)