Skip to content

Conversation

@FeynmanZhou
Copy link
Member

@FeynmanZhou FeynmanZhou commented Feb 20, 2025

Description

A Ratify Enhancement Proposal (REP) is a way to propose, communicate and coordinate on new features and enhancements for the Ratify project.

What this PR does / why we need it:

This PR adds a Ratify Enhancement Proposal Template to provide a consistent format for proposing new features and improvements, ensures contributors follow a structured approach, making it easier for maintainers to review proposals.

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

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes ##2121

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Signed-off-by: feynmanzhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou changed the title doc: add Ratify Enhancement Proposal Template docs: add Ratify Enhancement Proposal Template Feb 20, 2025
@codecov
Copy link

codecov bot commented Feb 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

see 1 file with indirect coverage changes

Copy link
Contributor

@binbin-li binbin-li left a comment

Choose a reason for hiding this comment

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

lgtm, thanks for adding it

@akashsinghal akashsinghal enabled auto-merge (squash) February 21, 2025 17:43
@akashsinghal akashsinghal merged commit 8d01fd6 into notaryproject:dev Feb 21, 2025
18 checks passed
@binbin-li binbin-li mentioned this pull request Jun 4, 2025
6 tasks
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.

3 participants