Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define Enhancement Process #1

Open
stevendborrelli opened this issue Apr 7, 2021 · 2 comments
Open

Define Enhancement Process #1

stevendborrelli opened this issue Apr 7, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@stevendborrelli
Copy link
Member

Overview

Define a enhancement process so that changes to the specification and design decisions are are shared and reviewed by the community. As COSI is early in the development cycle, the process should be lightweight but also be able to document the motivation behind design decisions.

Examples

@stevendborrelli
Copy link
Member Author

stevendborrelli commented Apr 8, 2021

A proposal to track early-stage COSI development.

  1. All Enhancement Requests for Comments (RFCs) are started via github issues in the cosi-project/enhancements repository.
  2. Format of the issue is detailed below. We can make this an issue template in the repo.
  3. COSI community provides comments on the issue and up/down issue are tallied.
  4. At weekly community meeting (or more frequently), status of open RFCs are reviewed.
  5. When RFC is accepted, the markdown file for the enhancement will be stored under the rfcs/ directory of this repository.

--
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.

@stevendborrelli stevendborrelli added the enhancement New feature or request label Apr 9, 2021
@souleb
Copy link

souleb commented Apr 14, 2021

We should add something concerning the status of an enhancement. Something like

  • proposed
  • implementable
  • implemented

And also maybe maintain a list of the enhancement. I have seen that being done directly in the readme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants