Update issue templates

This commit is contained in:
Sipke Schoorstra 2024-04-10 19:07:16 +02:00 committed by GitHub
parent e603e5480b
commit 5d600467f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 96 additions and 0 deletions

58
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,58 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''
---
## Description
A clear and concise description of what the bug is. Please include any error messages or codes here.
## Steps to Reproduce
To help us identify the issue more quickly, please follow these guidelines:
1. **Detailed Steps**: Provide a step-by-step description of what leads to the bug. Be as specific as possible.
2. **Code Snippets**: If the issue involves code (e.g., JavaScript error, server request failure), include the relevant snippets where the issue occurs.
3. **Attachments**:
- **Workflow JSON**: If your issue is reproducible with a specific workflow, please attach the workflow's JSON file. This will help us understand the exact process that leads to the problem.
- **Sample Project**: If possible, attach a minimal sample project or code that reproduces the issue. This could be a simplified version of your project that isolates and demonstrates the bug.
4. **Reproduction Rate**: Indicate how often the bug occurs when following these steps (e.g., "every time", "intermittently: about 50% of the time").
5. **Video/Screenshots**: Sometimes, complex behaviors are better shown than described. If you think a video or screenshots would help clarify the issue, please include them.
6. **Additional Configuration**:
- Mention any specific settings, features, or configurations that need to be enabled or present to reproduce the issue.
Providing a comprehensive and clear description will greatly assist in diagnosing the problem quickly and accurately. If you're unable to share some of the requested information publicly, please note that, and we can arrange for secure information transfer.
## Expected Behavior
Describe what you expected to happen.
## Actual Behavior
Describe what actually happened. Include screenshots, if applicable.
## Screenshots
If possible, add screenshots or screen recordings to help explain the problem.
## Environment
- **Elsa Package Version**: Specify the version. If you've cloned the repo, mention if you are using the latest source code from the main branch.
- **Operating System**: Include your OS version (e.g., Windows 10, macOS Big Sur, Ubuntu 18.04).
- **Browser and Version**: If applicable, include your browser and version (e.g., Chrome 92).
## Log Output
Include any relevant log output or error messages that might help diagnose the issue.
## Troubleshooting Attempts
Describe any steps you have taken to troubleshoot or resolve the issue yourself.
## Additional Context
Add any other context about the problem here. This could include the frequency of the issue (e.g., intermittent, every time), conditions under which the issue appears, etc.
## Related Issues
Link to any related issues here.

View file

@ -0,0 +1,38 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT]"
labels: enhancement
assignees: ''
---
## Feature Request
### Problem Overview
**Is your feature request related to a problem? Please describe.**
Provide a detailed explanation of the problem you are experiencing or the limitation you've encountered. This could be something that slows down your workflow, a capability that the product lacks, or any issue that this feature would address. For example, "I find it time-consuming to manually compile reports because..."
### Proposed Solution
**Describe the solution you'd like**
Explain in detail what you would like to see implemented. Describe how this feature would work, and why it would be a beneficial addition to the software. If possible, include any specific requirements or functionality you envision for this feature.
### Alternative Solutions
**Describe alternatives you've considered**
Have you found any workarounds or other software that accomplishes the same thing? Please share your findings, including why they might not have been a perfect fit. This helps us understand your needs better and evaluate the uniqueness of your request.
### Use Cases
**Identify potential use cases**
Who will benefit from this feature? Describe specific scenarios in which this feature would be used. This will help us understand the feature's impact and prioritize its development.
### Impact of Feature
**Explain the potential impact**
How would this feature improve your workflow, productivity, or product experience? Detailing the anticipated benefits can help stakeholders understand the value of the feature.
### Visuals and Mockups
**Provide any visuals**
If you have sketches, wireframes, screenshots, or any visual representation of your proposed feature, please attach them. Visuals can be very helpful in conveying your idea more clearly.
### Additional Context
**Add any other context**
Include any other information that might help clarify your request. This could be links to similar features in other products, technical considerations, or any other details that could inform the development process.