|
| 1 | +# Bedrock CLI Software Design Proposals |
| 2 | + |
| 3 | +## Summary |
| 4 | + |
| 5 | +Bedrock is a Microsoft open-source project focusing on Kubernetes deployment |
| 6 | +automation, observability, and infrastructure. This repository contains a CLI |
| 7 | +implementation of Bedrock concepts that are under constant design and |
| 8 | +implementation. |
| 9 | + |
| 10 | +When contributing a substantial design change we reccomend a design proposal. |
| 11 | +Below is a design proposal template with suggesteed headers to include in your |
| 12 | +design proposal to the Bedrock CLI. |
| 13 | + |
| 14 | +## Proposal Template |
| 15 | + |
| 16 | +### Design Proposal Title |
| 17 | + |
| 18 | +Reference: _What is this in reference to?_ |
| 19 | + |
| 20 | +Authors: _Names of authors_ |
| 21 | + |
| 22 | +| Revision | Date | Author | Remarks | |
| 23 | +| -------: | --------------- | ------------- | ------------- | |
| 24 | +| 0.1 | Month-Day, Year | _Author Name_ | Initial Draft | |
| 25 | + |
| 26 | +### Overview |
| 27 | + |
| 28 | +_Briefly describe what the proposed design is attempting to achieve. Think about |
| 29 | +the job to be done. What is the goal?_ |
| 30 | + |
| 31 | +### Out of Scope |
| 32 | + |
| 33 | +_Describe what is not relevant in this design. What are the non-goals?_ |
| 34 | + |
| 35 | +### Design Details |
| 36 | + |
| 37 | +_Describe the design in detail. Consider staging the design into steps._ |
| 38 | + |
| 39 | +### Dependencies |
| 40 | + |
| 41 | +_Describe what assumptions wee are making about dependencies in ordeer for your |
| 42 | +proposeed design to function correctly._ |
| 43 | + |
| 44 | +### Risks & Mitigations |
| 45 | + |
| 46 | +_Describe risks and how we plans to overcome or handle them in the proposed |
| 47 | +design._ |
| 48 | + |
| 49 | +### Documentation |
| 50 | + |
| 51 | +_Describe what documentation needs to be added or modified (if any)._ |
| 52 | + |
| 53 | +### Appendix |
| 54 | + |
| 55 | +_Reference any additional artifacts (docs, images, links) that would help give context to the proposed design._ |
0 commit comments