Skip to content

Commit e03a5d2

Browse files
openshift-merge-bot[bot]openshift-merge-bot[bot]
authored
Merge pull request #26985 from mheon/add_design_doc_conmonv3
Add a directory for design documents
2 parents cf06546 + 5b10b51 commit e03a5d2

File tree

2 files changed

+130
-0
lines changed

2 files changed

+130
-0
lines changed

‎contrib/design-docs/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Design Documents
2+
3+
This directory contains design information for Podman features that are being worked on or will be worked on in the future.
4+
All documents in this directory should be based on the [template](./TEMPLATE.md) provided.
5+
It is encouraged, but not required, that major features be preceded by a design document.
6+
This is intended to ensure major design changes are agreed to by maintainers before they are made.
7+
By discussing before implementing, we hope to avoid late-breaking issues discovered during code review that require rewrite of the feature.
8+
9+
Design documents should be posted in pull requests that clearly indicate they are a design document, and should include only the design document, with no other code or other changes.
10+
The pull request should remain open for at least 1 week for comment before it is merged. Maintainers for the component the design document refers to should be pinged on the pull request and encouraged to comment with their opinions.
11+
Once committed, the design is considered to be finalized.
12+
This does not mean changes cannot be made, but given a design has already been agreed to, the bar required to force changes has raised substantially.
13+
Design documents should be removed once the feature they reference is implemented.
14+
Removed documents remain in the Git history if they need to be referenced in the future.

‎contrib/design-docs/TEMPLATE.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Change Request
2+
3+
<!--
4+
This template is used to propose and discuss major new features to be added to Podman, Buildah, Skopeo, Netavark, and associated libraries.
5+
The creation of a design document prior to feature implementation is not mandatory, but is encouraged.
6+
Before major features are implemented, a pull request should be opened against the Podman repository with a completed version of this template.
7+
Discussion on the feature will occur in the pull request.
8+
Merging the pull request will constitute approval by project maintainers to proceed with implementation work.
9+
When the feature is completed and merged, this document should be removed to avoid cluttering the repository.
10+
It will remain in the Git history for future retrieval if necessary.
11+
-->
12+
13+
## **Short Summary**
14+
15+
<!--
16+
One to two sentence description of the proposal
17+
-->
18+
19+
## **Objective**
20+
21+
<!--
22+
What is this proposal trying to solve?
23+
Why is it necessary?
24+
-->
25+
26+
## **Detailed Description:**
27+
28+
<!--
29+
How should the feature be implemented?
30+
What considerations are there for the project if this is done?
31+
-->
32+
33+
## **Use cases**
34+
35+
<!--
36+
One or more short descriptions of use cases of the feature once complete.
37+
-->
38+
39+
## **Target Podman Release**
40+
41+
<!--
42+
When is this feature expected to be completed here?
43+
Are there hard deadlines to be aware of?
44+
-->
45+
46+
## **Link(s)**
47+
48+
<!--
49+
A list of links to relevant context.
50+
This can include Github issues describing the problem, related previous pull requests, or any other links that assist in understanding this change.
51+
The use of non-Github issue trackers - e.g. corporate or distribution Jira or Bugzilla instances - is allowed, but we ask that all links here be publicly accessible to ensure full context is available to all.
52+
Including a description with each link is not mandatory but is encouraged.
53+
-->
54+
55+
## **Stakeholders**
56+
57+
<!--
58+
A list of stakeholders who will be affected by this change.
59+
Please check any boxes that apply.
60+
For non-obvious stakeholders, you can add a brief sentence justifying after the checklist, but this is purely optional.
61+
-->
62+
- [ ] Podman Users
63+
- [ ] Podman Developers
64+
- [ ] Buildah Users
65+
- [ ] Buildah Developers
66+
- [ ] Skopeo Users
67+
- [ ] Skopeo Developers
68+
- [ ] Podman Desktop
69+
- [ ] CRI-O
70+
- [ ] Storage library
71+
- [ ] Image library
72+
- [ ] Common library
73+
- [ ] Netavark and aardvark-dns
74+
75+
## ** Assignee(s) **
76+
77+
<!--
78+
These people will lead implementation of the feature and drive it to completion.
79+
This does not have to be a comprehensive list of everyone who will work on the feature, but instead just the technical lead or leads.
80+
-->
81+
82+
## **Impacts**
83+
84+
### **CLI**
85+
86+
<!--
87+
Will there be any impact to the CLI?
88+
Do any options need to be added?
89+
Mocked output is strongly encouraged to help demonstrate the changes.
90+
-->
91+
92+
### **Libpod**
93+
94+
<!--
95+
Will there be any changes to the core container management logic?
96+
-->
97+
98+
### **Others**
99+
100+
<!--
101+
Are there any major impacts not mentioned above?
102+
-->
103+
104+
## **Further Description (Optional):**
105+
106+
<!--
107+
Is there anything not covered above that needs to be mentioned?
108+
-->
109+
110+
## **Test Descriptions (Optional):**
111+
112+
<!--
113+
How will this feature be tested?
114+
Detail which existing test suite or suites will be used (or, if a new suite is required, why this is necessary and how it will be implemented.
115+
Will this change require changes to the CI images (e.g. the inclusion of new packages) to be tested?
116+
-->

0 commit comments

Comments
 (0)