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: Litmus Enhancement Proposals directory #4223

Merged
merged 8 commits into from
Oct 29, 2023

Conversation

namkyu1999
Copy link
Member

@namkyu1999 namkyu1999 commented Oct 12, 2023

Proposed changes

I would like to suggest introducing Litmus Enhancement proposals. As our community continues to grow, we can come up with a lot of ideas. I have previously written a proposal for a backstage plugin using Google Docs, but now I propose posting proposals on GitHub. This approach has several advantages over using Google Docs.

  • In the case of Google Docs, the author retains ownership since it is a platform separate from GitHub. So, if the document is deleted, it cannot be archived.
  • Proposals are submitted through pull requests, allowing for feedback.
  • Since we store our documents in a GitHub directory, we don't need to create a GitHub wiki to archive them.

People who want to propose new features for Litmus can use the template to submit a new proposal.

Types of changes

What types of changes does your code introduce to Litmus? Put an x in the boxes that apply

  • New feature (non-breaking change which adds functionality)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices applies)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the commit for DCO to be passed.
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added necessary documentation (if appropriate)

Dependency

Special notes for your reviewer:

@namkyu1999 namkyu1999 self-assigned this Oct 12, 2023
@gdsoumya
Copy link
Member

+1 on this, as a reference, I'd suggest taking a look at ArgoCD proposal template, it has been there for some time and seems to work pretty well.

@Saranya-jena
Copy link
Contributor

@gdsoumya Can you PTAL?

Copy link
Member

@gdsoumya gdsoumya left a comment

Choose a reason for hiding this comment

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

LGTM

@Saranya-jena Saranya-jena merged commit f2275e4 into litmuschaos:master Oct 29, 2023
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants