Merge pull request #37 from ksctl/new-cli

✨ New CLI UX

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,95 +1,115 @@
 name: Bug Report
-description: Report a bug to help us improve
-title: "[Bug Report]: "
+description: "🐛 Report a bug to help us improve"
+title: "[Bug]: "
 labels: ["kind/bug", "needs-triage", "priority/high"]
 
 body:
   - type: markdown
     attributes:
       value: |
-        **Thank you for reporting a bug.** Your feedback is valuable to us. Please fill in as much of the template below as you're able, to help us better understand and fix the bug.
+        # 🔍 Bug Report
+
+        Thank you for taking the time to report a bug! Your feedback helps make our project better.
+
+        > 💡 Before submitting, please search existing issues to avoid duplicates.
+
+        Please fill out the information below as detailed as possible.
 
   - type: input
     id: bug-title
     attributes:
-      label: Bug Title
-      description: Provide a concise title that summarizes the bug.
-      placeholder: Short and descriptive title of the bug
+      label: "📝 Bug Title"
+      description: "Give your bug a clear and descriptive title"
+      placeholder: "Example: CLI crashes when creating cluster with custom configuration"
     validations:
       required: true
 
   - type: textarea
     id: steps-to-reproduce
     attributes:
-      label: Steps to Reproduce
-      description: Describe the steps to reproduce the bug. Be as detailed as possible.
-      placeholder: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
+      label: "🔄 Steps to Reproduce"
+      description: "Help us recreate the issue by providing detailed steps"
+      placeholder: |
+        1. Install ksctl version X.Y.Z
+        2. Run command `...`
+        3. Configure settings with...
+        4. Observe error...
     validations:
       required: true
 
   - type: textarea
     id: expected-behavior
     attributes:
-      label: Expected Behavior
-      description: Describe what you expected to happen.
-      placeholder: Describe the expected outcome after following the steps above.
+      label: "✅ Expected Behavior"
+      description: "What should have happened?"
+      placeholder: "Describe what you expected to happen when following the steps above"
     validations:
       required: true
 
   - type: textarea
     id: actual-behavior
     attributes:
-      label: Actual Behavior
-      description: Describe what actually happened instead.
-      placeholder: Describe the actual outcome after following the steps above.
+      label: "❌ Actual Behavior"
+      description: "What happened instead?"
+      placeholder: |
+        Describe what actually happened. If you have error messages or screenshots, please include them here.
+
+        ```
+        Include any error messages or logs here
+        ```
     validations:
       required: true
 
   - type: input
     id: environment
     attributes:
-      label: Environment
-      description: Include details like the ksctl version, operating system, and the version of the software in which the bug occurred.
-      placeholder: e.g., ksctl cli on Windows 10, version 1.3 
+      label: "🖥️ Environment"
+      description: |
+        Tell us about your environment (OS, software versions, etc.)
+      placeholder: "ksctl v1.3.0, Ubuntu 22.04, Docker 24.0.5"
     validations:
       required: true
 
   - type: textarea
     id: additional-context
     attributes:
-      label: Additional Context
-      description: Provide any additional context about the problem here. Screenshots or error logs are very helpful.
-      placeholder: Any additional information, screenshots, or logs that might help us understand the problem better.
+      label: "📎 Additional Context"
+      description: |
+        Add any other context, screenshots, or logs about the problem here.
+        Tip: You can attach images by dragging & dropping them into this field.
+      placeholder: "Share any additional information that might help us understand the issue better"
     validations:
       required: false
 
   - type: checkboxes
-    id: confirmation
+    id: affected-components
     attributes:
-      label: Confirmation
-      description: "Please confirm the following:"
+      label: "🎯 Affected Components"
+      description: "Which parts of the project are affected by this bug?"
       options:
-        - label: I have searched the existing issues and this is a new and unique bug report.
-          required: true
-        - label: I agree to provide follow-up information if needed.
-          required: true
+        - label: "🖥️ CLI"
+        - label: "🎨 UI"
+        - label: "📚 Documentation"
+        - label: "🔧 Core Functionality"
+        - label: "🔌 Plugins/Extensions"
 
   - type: checkboxes
-    id: updates
+    id: confirmations
     attributes:
-      label: Scope of changes
-      description: what all subprojects will be affected?
+      label: "✔️ Confirmations"
+      description: "Please confirm the following:"
       options:
-        - label: Cli
-        - label: UI
-        - label: Docs
+        - label: "🔍 I have searched existing issues and verified this is a new bug"
+          required: true
+        - label: "💬 I will respond to questions and updates in this bug report"
+          required: true
+        - label: "📜 I have read and agree to follow the [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)"
+          required: true
 
-  - type: checkboxes
-    id: agreement
+  - type: markdown
     attributes:
-      label: Agreement
-      description: By submitting this feature proposal, you agree to engage in constructive discussion and follow our [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)
-      options:
-        - label: I agree to engage in constructive discussion and follow the Contribution Guidelines.
-          required: true
+      value: |
+        ---
+        👥 Our maintainers will review your bug report and get back to you as soon as possible.
 
+        ⭐ Thank you for contributing to make our project better!

.github/ISSUE_TEMPLATE/enhancement-proposal.yml

@@ -1,76 +1,128 @@
 name: Enhancement Proposal
-description: Suggest an enhancement for an existing feature or propose a new functionality
-title: "[Enhancement Proposal]: "
+description: "✨ Propose new features or improvements to existing functionality"
+title: "[Enhancement]: "
 labels: ["kind/enhancement", "needs-triage"]
 
 body:
   - type: markdown
     attributes:
       value: |
-        **Thank you for suggesting an enhancement.** Please fill in as much of the template below as you're able. Your proposal will help us understand your ideas better and improve the project.
+        # ✨ Enhancement Proposal
+
+        Thank you for helping improve our project! Your ideas and suggestions are valuable to us.
+
+        > 💡 Before submitting, please check if a similar enhancement has been proposed.
+
+        Let's hear about your amazing idea! 🚀
 
   - type: input
     id: enhancement-title
     attributes:
-      label: Enhancement Title
-      description: Provide a concise title for your enhancement proposal.
-      placeholder: Short and descriptive title
+      label: "📌 Enhancement Title"
+      description: "Give your enhancement a clear and descriptive title"
+      placeholder: "Example: Add support for custom backup schedules"
     validations:
       required: true
 
   - type: textarea
     id: enhancement-summary
     attributes:
-      label: Summary of the Enhancement
-      description: A brief summary of the enhancement you're proposing.
-      placeholder: What enhancement are you proposing and why?
+      label: "💫 Enhancement Summary"
+      description: "Provide a brief overview of your proposed enhancement"
+      placeholder: |
+        Briefly describe:
+        - What is the enhancement?
+        - Who will benefit from it?
+        - How does it improve the project?
     validations:
       required: true
 
   - type: textarea
     id: motivation-and-goals
     attributes:
-      label: Motivation and Goals
-      description: What motivates you to propose this enhancement? What goals do you aim to achieve?
-      placeholder: Explain the motivation behind this proposal and what you hope to achieve.
+      label: "🎯 Motivation and Goals"
+      description: "Help us understand the 'why' behind your proposal"
+      placeholder: |
+        - What problem does this solve?
+        - What use cases does it address?
+        - What benefits will it bring to users?
     validations:
       required: true
 
   - type: textarea
     id: detailed-design
     attributes:
-      label: Detailed Design
-      description: Describe in detail how this enhancement should be implemented. Include any specific technical requirements, methods, or steps.
-      placeholder: Detailed description of the enhancement's design and implementation.
+      label: "🔨 Detailed Design"
+      description: "Describe how your enhancement should work"
+      placeholder: |
+        Please include:
+        - Technical implementation details
+        - Required changes to existing features
+        - Any new interfaces or APIs
+        - Performance considerations
+
+        You can use diagrams or code examples:
+        ```yaml
+        example:
+          configuration:
+            - setting: value
+        ```
     validations:
       required: true
 
   - type: textarea
     id: alternatives
     attributes:
-      label: Alternatives
-      description: Have you considered any alternative solutions or features? Why is your proposed enhancement preferable?
-      placeholder: Describe any alternative solutions or features you've considered.
+      label: "🤔 Alternative Approaches"
+      description: "What other approaches have you considered?"
+      placeholder: |
+        - Alternative solution 1 and why it was not chosen
+        - Alternative solution 2 and its trade-offs
+        - Current workarounds, if any
     validations:
       required: false
 
   - type: checkboxes
-    id: updates
+    id: impact-areas
     attributes:
-      label: Scope of changes
-      description: what all subprojects will be affected?
+      label: "🎯 Impact Areas"
+      description: "Which parts of the project will be affected?"
       options:
-        - label: Cli
-        - label: UI
-        - label: Docs
+        - label: "🖥️ CLI - Command line interface changes"
+        - label: "🎨 UI - User interface modifications"
+        - label: "📚 Documentation - Documentation updates"
+        - label: "⚙️ Core - Core functionality changes"
+        - label: "🔌 API - API modifications"
+        - label: "🧪 Tests - Test suite updates"
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: "📎 Additional Context"
+      description: "Any other context or screenshots about the enhancement"
+      placeholder: "Add any other relevant information, mockups, or examples here"
+    validations:
+      required: false
 
   - type: checkboxes
     id: agreement
     attributes:
-      label: Agreement
-      description: By submitting this feature proposal, you agree to engage in constructive discussion and follow our [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)
+      label: "📝 Agreement"
+      description: |
+        By submitting this enhancement proposal, you agree to:
       options:
-        - label: I agree to engage in constructive discussion and follow the Contribution Guidelines.
+        - label: "🤝 Engage in constructive discussion and follow our [Contribution Guidelines](https://docs.ksctl.com/docs/contribution-guidelines/)"
           required: true
+        - label: "💪 Help implement this enhancement if approved (optional)"
+        - label: "📢 Provide additional information if requested"
+          required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ---
+        ### 🙏 Thank you for your contribution!
 
+        Your enhancement proposal will be reviewed by our maintainers. We'll discuss the implementation details and feasibility together.
 
+        > ⭐ Don't forget to star the repository if you haven't already!