Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs: simplify issue and pull request templates

Tincb6ce20252ac
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 9abd2622a..92d7a5a74 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,71 +1,24 @@
-name: "Bug Report"
-description: Create a report to help us improve Kaneo
+name: Bug report
+description: Report something that is not working in Kaneo
title: "[Bug]: "
-labels: ["bug"]
+labels: [bug]
body:
- type: textarea
id: description
attributes:
- label: "Bug Description"
- description: "Description of the bug"
- placeholder: |
- Example:
- A clear and concise description of what the bug is.
+ label: What happened?
+ description: Describe the problem and what you expected instead.
validations:
required: true
- type: textarea
- id: reproduction_steps
+ id: reproduction
attributes:
- label: "Steps To Reproduce"
- description: "The sequence of actions to reproduce the bug"
- placeholder: |
- Example:
- 1. Go to '...'
- 2. Click on '....'
- 3. Scroll down to '....'
- 4. See error
- validations:
- required: true
-
- - type: textarea
- id: expected_result
- attributes:
- label: "Expected Behavior"
- description: "A clear and concise description of what you expected to happen."
- placeholder: "Example: Behavior remains the same as it was"
- validations:
- required: true
-
- - type: textarea
- id: actual_result
- attributes:
- label: "Actual result"
- placeholder: "Example: The behavior has changed '...'"
- validations:
- required: true
-
- - type: textarea
- id: screenshots
- attributes:
- label: "Screenshots"
- description: "If applicable, add screenshots to help explain your problem."
+ label: How can we reproduce it?
+ description: Include steps, a recording, or logs if you have them.
- type: textarea
id: environment
attributes:
- label: "Environment"
- placeholder: |
- Example:
- - Kaneo Version: [e.g., 1.0.0]
- - Deployment Method: [e.g., Docker, Kubernetes, etc.]
- - Browser: [e.g., Chrome 120, Firefox 119]
- - OS: [e.g., Windows 11, macOS Sonoma, Ubuntu 22.04]
- validations:
- required: true
-
- - type: textarea
- id: additional_context
- attributes:
- label: "Additional Context"
- description: "Add any other context about the problem here."
\ No newline at end of file
+ label: Environment
+ description: Include your Kaneo version and deployment method. Add browser or OS details if relevant.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index 4e68b8f3c..5e1f10d3e 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,51 +1,18 @@
-name: "Feature request"
-description: "Suggest an idea for Kaneo"
+name: Feature request
+description: Suggest an improvement to Kaneo
title: "feat: "
-labels: ["enhancement"]
+labels: [enhancement]
body:
- - type: markdown
- attributes:
- value: |
- Thanks for taking the time to suggest a feature for **Kaneo**! 🎯
- Please fill out the sections below to help us understand your idea.
-
- - type: textarea
- id: problem
- attributes:
- label: "Problem Statement"
- description: "A clear and concise description of what problem this feature would solve."
- placeholder: "Example: I'm always frustrated when [...]"
- validations:
- required: true
-
- type: textarea
- id: solution
+ id: feature
attributes:
- label: "Proposed Solution"
- description: "A clear and concise description of what you want to happen."
- validations:
- required: true
-
- - type: textarea
- id: altsolution
- attributes:
- label: "Alternative Solutions"
- description: "A clear and concise description of any alternative solutions or features you've considered."
+ label: What would you like to change?
+ description: Describe the problem, your idea, and how it would help you.
validations:
required: true
- type: textarea
id: context
attributes:
- label: "Relevant Context"
- description: "Add any other context, screenshots, or examples about the feature request here."
- validations:
- required: true
-
- - type: textarea
- id: simplicity
- attributes:
- label: "Does this feature align with Kaneo's focus on simplicity?"
- description: "Yes/No, because..."
- validations:
- required: true
+ label: Additional context
+ description: Add examples, alternatives, or screenshots if useful.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index 8646e39ef..5eea6c0b3 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -1,25 +1,10 @@
---
-name: Question or Help
-about: Ask a question or request help with Kaneo
+name: Question or help
+about: Ask a question about Kaneo
title: 'question: '
labels: question
-assignees: ''
---
-## Question
-A clear and concise description of your question.
+## What do you need help with?
-## What I've Tried
-Steps you've already taken to find an answer:
-1. Checked documentation at...
-2. Searched for similar issues...
-3. Tried to...
-
-## Environment (if relevant)
-- Kaneo Version: [e.g., 1.0.0]
-- Deployment Method: [e.g., Docker, Kubernetes, etc.]
-- Browser: [e.g., Chrome, Firefox]
-- OS: [e.g., Windows, macOS, Linux]
-
-## Additional Context
-Add any other context or screenshots about your question here.
\ No newline at end of file
+<!-- Include what you have tried and your setup if relevant. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9a15c6b90..58b677946 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,40 +1,11 @@
-## Description
-<!-- Provide a brief summary of the changes in this PR -->
+## What changed?
-## Related Issue(s)
-<!-- Link to the related issue(s) this PR addresses -->
-Fixes #
+<!-- Briefly explain the change and why it is needed. -->
-## Type of Change
-<!-- Mark the appropriate option with an "x" -->
-- [ ] Bug fix (non-breaking change that fixes an issue)
-- [ ] New feature (non-breaking change that adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Documentation update
-- [ ] Refactoring (no functional changes)
-- [ ] Performance improvement
-- [ ] Test addition or update
-- [ ] Other (please describe):
+## Related issue
-## How Has This Been Tested?
-- [ ] Unit tests
-- [ ] Integration tests
-- [ ] Manual testing
-- [ ] Other (please describe):
+<!-- Link an issue if there is one, for example: Fixes #123. -->
-## Screenshots (if applicable)
+## How did you check it?
-## Checklist
-<!-- Mark the appropriate options with an "x" -->
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my own code
-- [ ] I understand and take responsibility for every change, and I wrote this pull request description in my own words
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes
-- [ ] Any dependent changes have been merged and published
-
-## Additional Notes
-<!-- Add any other context about the PR here -->
+<!-- List tests or manual checks. Add screenshots for visual changes when useful. -->