Skip to content

docs: add an enhancement proposal doc template#1621

Merged
FeynmanZhou merged 5 commits into
oras-project:mainfrom
FeynmanZhou:doc-template
Feb 22, 2025
Merged

docs: add an enhancement proposal doc template#1621
FeynmanZhou merged 5 commits into
oras-project:mainfrom
FeynmanZhou:doc-template

Conversation

@FeynmanZhou

@FeynmanZhou FeynmanZhou commented Feb 11, 2025

Copy link
Copy Markdown
Member

What this PR does / why we need it:

I am proposing an enhancement proposal doc template to frame the content and make sure necessary background/scenarios of each proposal are included. It will be easier for reviewers to understand the proposal and provide feedback.

This is a common practice that a few mature communities like Kubernetes are applying https://github.com/kubernetes/enhancements/blob/master/keps/README.md

Please check the following list:

  • Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • Does this change require a documentation update?
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have an appropriate license header?

@codecov

codecov Bot commented Feb 11, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.27%. Comparing base (a9004d4) to head (e996a0a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1621      +/-   ##
==========================================
- Coverage   84.31%   84.27%   -0.04%     
==========================================
  Files         121      121              
  Lines        5566     5566              
==========================================
- Hits         4693     4691       -2     
- Misses        619      621       +2     
  Partials      254      254              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@FeynmanZhou FeynmanZhou changed the title docs: add a proposal doc template docs: add an enhancement proposal doc template Feb 12, 2025
Comment thread docs/proposals/proposal-doc-template.md Outdated
@FeynmanZhou FeynmanZhou requested a review from yizha1 February 14, 2025 08:39

@shizhMSFT shizhMSFT left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Wwwsylvia Wwwsylvia left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yizha1 yizha1 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: feynmanzhou <feynmanzhou@microsoft.com>
Signed-off-by: feynmanzhou <feynmanzhou@microsoft.com>
Signed-off-by: feynmanzhou <feynmanzhou@microsoft.com>
Signed-off-by: feynmanzhou <feynmanzhou@microsoft.com>
Signed-off-by: feynmanzhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou merged commit c522ae0 into oras-project:main Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants