[IMP] Change issue templates for bugs and feature request from md to yml

This commit is contained in:
Horilla
2025-04-11 15:16:21 +05:30
parent c6f5b01350
commit bd0a442aa7
5 changed files with 282 additions and 111 deletions

View File

@@ -1,63 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
# Bug Report
## Description
_[A brief description of the bug or issue you're encountering.]_
## Steps to Reproduce
1. _[Detailed step-by-step instructions to reproduce the issue.]_
## Expected Behavior
_[What you expected to happen.]_
## Actual Behavior
_[What actually happened.]_
## Screenshots
_[If applicable, provide screenshots illustrating the issue.]_
## Environment
- **Django Version:** _[Django version you're using, e.g., 3.2.1]_
- **Python Version:** _[Python version, e.g., 3.9]_
- **Operating System:** _[Your OS, e.g., Windows 10, Ubuntu 20.04]_
- **Browser:** _[If applicable, specify the browser and version you're using.]_
## Additional Information
_[Any other relevant information, logs, error messages, or context that might help in understanding and fixing the issue.]_
## Possible Solution
_[If you have any ideas or suggestions on how to fix the issue, feel free to provide them here. This is optional.]_
## Labels
_[If your project uses labels, suggest any labels that might apply to this issue, such as 'bug', 'needs investigation', etc.]_
## Priority
_[Specify the priority level for this issue, such as 'high', 'medium', 'low', etc.]_
## Assignees
_[If you want to suggest an assignee or tag a specific person to look into this issue, mention their GitHub username here.]_
## Related Issues
_[If there are any related issues or pull requests, mention them here. This is optional.]_
**Note:** _Remember to search through existing issues before submitting a new one to ensure that the issue hasn't been reported already. Provide as much information as possible to help the maintainers understand and address the problem effectively._

154
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,154 @@
name: Bug Report
description: Create a report to help us improve Horilla
title: "[Bug] <short description>"
labels: ["bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for helping improve Horilla! Please provide detailed information below to assist us in resolving the issue. Search existing issues first to avoid duplicates.
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the bug or issue you're encountering.
placeholder: "E.g., Attendance report crashes when filtering by date."
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Detailed step-by-step instructions to reproduce the issue.
placeholder: |
1. Go to Attendance module
2. Select 'Filter by Date'
3. Enter '2025-04-01' to '2025-04-10'
4. Click 'Apply'
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What you expected to happen.
placeholder: "E.g., A report listing all attendance records for the date range."
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened.
placeholder: "E.g., Page crashes with a 500 Internal Server Error."
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, drag and drop screenshots illustrating the issue.
placeholder: "E.g., Upload an image of the error page."
validations:
required: false
- type: input
id: django-version
attributes:
label: Django Version
description: The Django version you're using.
placeholder: "E.g., 3.2.1"
validations:
required: true
- type: input
id: python-version
attributes:
label: Python Version
description: The Python version you're using.
placeholder: "E.g., 3.9"
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: Your operating system.
placeholder: "E.g., Ubuntu 20.04"
validations:
required: true
- type: input
id: browser
attributes:
label: Browser
description: If applicable, specify the browser and version.
placeholder: "E.g., Chrome 123.0"
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Information
description: Any logs, error messages, or context that might help.
placeholder: "E.g., Error log: 'Traceback: ValueError at /attendance...'"
validations:
required: false
- type: textarea
id: solution
attributes:
label: Possible Solution
description: Optional - Suggest how this might be fixed.
placeholder: "E.g., Check date parsing logic in attendance/views.py."
validations:
required: false
- type: dropdown
id: labels
attributes:
label: Labels
description: Suggest labels for this issue.
multiple: true
options:
- bug
- needs investigation
- documentation
- enhancement
default: 0
validations:
required: false
- type: dropdown
id: priority
attributes:
label: Priority
description: Specify the priority level for this issue.
options:
- High
- Medium
- Low
default: 1
validations:
required: true
- type: input
id: assignees
attributes:
label: Assignees
description: Optional - Suggest GitHub usernames to assign this issue (e.g., @username).
placeholder: "E.g., @horilla-dev"
validations:
required: false
- type: textarea
id: related
attributes:
label: Related Issues
description: Optional - Mention related issues or pull requests.
placeholder: "E.g., Related to #123 or PR #456"
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: Submission Checklist
description: Confirm these before submitting.
options:
- label: I have searched for duplicate issues
required: true
- label: I have provided as much detail as possible
required: true

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Horilla Community Support
url: https://github.com/horilla-opensource/horilla/discussions
about: Ask questions or discuss features here
- name: Documentation
url: https://horilla-opensource.github.io/horilla-docs/
about: Check the official Horilla documentation

View File

@@ -1,48 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
# Feature Request
## Description
_[A brief description of the new feature you're requesting.]_
## Use Case
_[Explain how this feature would be useful and how it fits into the project's context.]_
## Proposed Solution
_[Provide your ideas or suggestions on how this feature could be implemented. This is optional.]_
## Benefits
_[Highlight the benefits and value this feature would bring to users or the project as a whole.]_
## Additional Information
_[Any other relevant information, details, or examples related to the feature request.]_
## Labels
_[If your project uses labels, suggest any labels that might apply to this feature request, such as 'enhancement', 'feature request', etc.]_
## Priority
_[Specify the priority level for this feature request, such as 'high', 'medium', 'low', etc.]_
## Assignees
_[If you want to suggest an assignee or tag a specific person to consider this feature request, mention their GitHub username here.]_
## Related Issues
_[If there are any related issues or pull requests, mention them here. This is optional.]_
**Note:** _Before submitting a new feature request, please search through existing issues to ensure that the feature hasn't been requested already. Provide clear and concise information to help the maintainers understand the proposed feature and its potential impact._

View File

@@ -0,0 +1,120 @@
name: Feature Request
description: Suggest an idea to enhance Horilla
title: "[Feature] <short description>"
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a new feature for Horilla! Please fill out the fields below to help us understand your idea. Search existing issues first to avoid duplicates.
- type: dropdown
id: module
attributes:
label: Target Module
description: Which Horilla module would this feature apply to?
options:
- Recruitment
- Employee Onboarding
- Attendance
- Leave Management
- Payroll
- Performance Management
- Asset Management
- General (cross-module)
- Other (specify below)
default: 0
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the new feature you're requesting.
placeholder: "E.g., Add a shift scheduling tool to the Attendance module."
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: Explain how this feature would be useful and how it fits into Horilla's context.
placeholder: "E.g., Managers need to assign shifts for employees working in multiple time zones."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Optional - Provide ideas on how this feature could be implemented.
placeholder: "E.g., Add a new 'Shifts' tab with a calendar view and drag-and-drop scheduling."
validations:
required: false
- type: textarea
id: benefits
attributes:
label: Benefits
description: Highlight the value this feature would bring to users or the project.
placeholder: "E.g., Simplifies scheduling, reduces manual errors, and improves employee satisfaction."
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Information
description: Any other details, examples, or mockups related to the feature request.
placeholder: "E.g., Similar feature seen in [other HRMS]. Attach mockups here."
validations:
required: false
- type: dropdown
id: labels
attributes:
label: Labels
description: Suggest labels for this feature request.
multiple: true
options:
- enhancement
- feature request
- needs discussion
- documentation
default: 0
validations:
required: false
- type: dropdown
id: priority
attributes:
label: Priority
description: Specify the priority level for this feature.
options:
- High
- Medium
- Low
default: 1
validations:
required: true
- type: input
id: assignees
attributes:
label: Assignees
description: Optional - Suggest GitHub usernames to assign this request (e.g., @username).
placeholder: "E.g., @horilla-dev"
validations:
required: false
- type: textarea
id: related
attributes:
label: Related Issues
description: Optional - Mention related issues or pull requests.
placeholder: "E.g., Related to #123 or PR #456"
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: Submission Checklist
description: Confirm these before submitting.
options:
- label: I have searched for duplicate feature requests
required: true
- label: I have provided clear and concise information
required: true