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

Add enhancement proposal document and template #680

Merged
merged 21 commits into from
Jun 8, 2023

Conversation

kate-osborn
Copy link
Contributor

@kate-osborn kate-osborn commented May 25, 2023

Proposed changes

Adds Enhancement Proposal (EP) process document and template. The process and template are based on GEPs but also include some of our design doc requirements.

This is just a starting point. I'm looking for feedback on the process and am open to making any changes.

Closes #672

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@kate-osborn kate-osborn requested a review from a team as a code owner May 25, 2023 00:46
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 25, 2023
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/template.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn requested a review from mpstefan May 25, 2023 16:58
@kate-osborn
Copy link
Contributor Author

Once #669 is merged, I'll update this PR and add a link to this doc to CONTRIBUTING.md

eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
@mpstefan
Copy link
Collaborator

May seem like a minor thing, but can we replace any mention of the abbreviation "EP" (including the directory) to "Enhancement Proposal"? Using abbreviations is another barrier to understanding what is going on in the community that we can easily remove.

.github/ISSUE_TEMPLATE/enhancement.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/template.md Outdated Show resolved Hide resolved
eps/template.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
eps/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

docs/proposals/README.md Outdated Show resolved Hide resolved
docs/proposals/README.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn merged commit 4faa2de into nginxinc:main Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add enhancement proposal process document
5 participants