diff options
| author | Scott Dodson <sdodson@redhat.com> | 2017-09-13 09:11:11 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-13 09:11:11 -0400 |
| commit | 2e0059890277f1e08b47bda9fe3c10507ccfaf97 (patch) | |
| tree | 2f3812dcb34995864e48fe442755d3faa368f0f0 /docs | |
| parent | e1754cbde4aeddfb5bc0d58984510c648de7ced4 (diff) | |
| parent | 240d66b067b783360ccade19ba245ab951d1d208 (diff) | |
| download | openshift-2e0059890277f1e08b47bda9fe3c10507ccfaf97.tar.gz openshift-2e0059890277f1e08b47bda9fe3c10507ccfaf97.tar.bz2 openshift-2e0059890277f1e08b47bda9fe3c10507ccfaf97.tar.xz openshift-2e0059890277f1e08b47bda9fe3c10507ccfaf97.zip | |
Merge pull request #5321 from mtnbikenc/proposal-process
[Proposal] OpenShift-Ansible Proposal Process
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/proposals/README.md | 27 | ||||
| -rw-r--r-- | docs/proposals/proposal_template.md | 30 |
2 files changed, 57 insertions, 0 deletions
diff --git a/docs/proposals/README.md b/docs/proposals/README.md new file mode 100644 index 000000000..89bbe5163 --- /dev/null +++ b/docs/proposals/README.md @@ -0,0 +1,27 @@ +# OpenShift-Ansible Proposal Process + +## Proposal Decision Tree +TODO: Add details about when a proposal is or is not required. + +## Proposal Process +The following process should be followed when a proposal is needed: + +1. Create a pull request with the initial proposal + * Use the [proposal template][template] + * Name the proposal using two or three topic words with underscores as a separator (i.e. proposal_template.md) + * Place the proposal in the docs/proposals directory +2. Notify the development team of the proposal and request feedback +3. Review the proposal on the OpenShift-Ansible Architecture Meeting +4. Update the proposal as needed and ask for feedback +5. Approved/Closed Phase + * If 75% or more of the active development team give the proposal a :+1: it is Approved + * If 50% or more of the active development team disagrees with the proposal it is Closed + * If the person proposing the proposal no longer wishes to continue they can request it to be Closed + * If there is no activity on a proposal, the active development team may Close the proposal at their discretion + * If none of the above is met the cycle can continue to Step 4. +6. For approved proposals, the current development lead(s) will: + * Update the Pull Request with the result and merge the proposal + * Create a card on the Cluster Lifecycle [Trello board][trello] so it may be scheduled for implementation. + +[template]: proposal_template.md +[trello]: https://trello.com/b/wJYDst6C diff --git a/docs/proposals/proposal_template.md b/docs/proposals/proposal_template.md new file mode 100644 index 000000000..ece288037 --- /dev/null +++ b/docs/proposals/proposal_template.md @@ -0,0 +1,30 @@ +# Proposal Title + +## Description +<Short introduction> + +## Rationale +<Summary of main points of Design> + +## Design +<Main content goes here> + +## Checklist +* Item 1 +* Item 2 +* Item 3 + +## User Story +As a developer on OpenShift-Ansible, +I want ... +so that ... + +## Acceptance Criteria +* Verify that ... +* Verify that ... +* Verify that ... + +## References +* Link +* Link +* Link |