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

docs: add an enhancement proposal doc template #1621

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

FeynmanZhou
Copy link
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.

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?

Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.27%. Comparing base (a9004d4) to head (e996a0a).

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.

Copy link
Member

@TerryHowe TerryHowe left a comment

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
@FeynmanZhou FeynmanZhou requested a review from yizha1 February 14, 2025 08:39
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@yizha1 yizha1 left a comment

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