diff --git a/.github/ISSUE_TEMPLATE/enhancement-template.md b/.github/ISSUE_TEMPLATE/enhancement-template.md index 23ff010..9663024 100644 --- a/.github/ISSUE_TEMPLATE/enhancement-template.md +++ b/.github/ISSUE_TEMPLATE/enhancement-template.md @@ -1,12 +1,14 @@ --- name: Enhancement template +authors: '' about: Proposals for Enhancements to the COSI Specification title: "[ENHANCEMENT]" labels: enhancement +status: '' assignees: '' - --- + A proposal to track early-stage COSI development. -- diff --git a/README.md b/README.md index 81a9463..d2ee92d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# enhancements -Proposed Enhancements to the COSI Specification +# COSI Enhancements Proposals + +Proposed Enhancements to the COSI Specification. + +A way to propose, communicate and coordinate on new efforts for the COSI project. + + +## Review Process + +An new enhancement status is `proposed`. The enhancements is then set to `implementable` once approved. The final status is `implemented`, once the implementation work is done. + +In order to keep it simple, Github reviewers feature is used as review process. + +The enahncememnts will also be discussed during weekly community meetings. + +## Proposals list + +This is the complete list of the enhancements: + +| Proposal | Title | Status | Last Updated | +|------|--------|----------|---------------| + diff --git a/proposals/enhancement-template.md b/proposals/enhancement-template.md new file mode 100644 index 0000000..9663024 --- /dev/null +++ b/proposals/enhancement-template.md @@ -0,0 +1,41 @@ +--- +name: Enhancement template +authors: '' +about: Proposals for Enhancements to the COSI Specification +title: "[ENHANCEMENT]" +labels: enhancement +status: '' +assignees: '' +--- + + +A proposal to track early-stage COSI development. + +-- +Title: Enhancement Template +Name: Author Name +Date: YYYY-MM-DD + +## Summary + +Brief overview of the enhancement. + +## Motivation + +Why are you proposing this change? Provide background, including other ideas considered. + +## Proposal + +A description of the proposal, including code example and/or architectural diagrams. + +### Examples + +Provide code examples of how the enhancement would be used. + +## References/Prior Art + +Provide any reference links or prior art that inspired this RFC. + +## Developer's Certificate of Origin + +I certify this enhancement proposal is in accordance with the [Developer's Certificate of Origin, version 1.1](https://developercertificate.org).