Add project files.
This commit is contained in:
@@ -0,0 +1,58 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a bug report to help us improve
|
||||
title: ""
|
||||
type: 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.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
name: Documentation
|
||||
about: Suggest improvements to the documentation for this project
|
||||
title: ""
|
||||
Type: Documentation
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Documentation Improvement Request
|
||||
|
||||
### Documentation Issue Overview
|
||||
**Is your documentation issue related to a specific problem? Please describe.**
|
||||
Provide a detailed explanation of what is lacking or incorrect in the current documentation. For example, "The installation guide lacks details on how to set up the environment on Windows systems..."
|
||||
|
||||
### Proposed Documentation Changes
|
||||
**Describe the changes or additions you'd like**
|
||||
Detail what changes or additions are needed in the documentation. Explain how these changes would improve the clarity, completeness, or accuracy of the existing documents.
|
||||
|
||||
### Affected Sections
|
||||
**Identify which sections of the documentation are affected**
|
||||
Specify which parts of the documentation need updating. This could include README files, API docs, user manuals, or setup guides.
|
||||
|
||||
### Impact of Changes
|
||||
**Explain the potential impact**
|
||||
Discuss how these documentation changes will improve usability, understanding, or adoption of the project. Detailing the benefits can help stakeholders prioritize documentation improvements.
|
||||
|
||||
### Additional Context
|
||||
**Add any other context or visuals**
|
||||
Include any other information, links, or visuals that might help clarify your request. Visuals can be particularly useful in documentation to explain complex processes or configurations.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ""
|
||||
type: Feature
|
||||
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.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Improvement
|
||||
about: Suggest an enhancement to an existing feature for this project
|
||||
title: ""
|
||||
type: Improvement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Enhancement Request
|
||||
|
||||
### Enhancement Overview
|
||||
**Is your enhancement request related to a problem? Please describe.**
|
||||
Provide a detailed explanation of the limitation or the inefficiency you are experiencing with the current feature. Describe the context and specific scenarios where the feature falls short. For example, "The current search functionality does not support filtering by date, which makes it difficult to..."
|
||||
|
||||
### Proposed Enhancement
|
||||
**Describe the enhancement you'd like**
|
||||
Explain in detail how you would like to enhance the existing feature. Describe what changes or additions you propose and how they would work. Discuss why this enhancement would be beneficial to the software and its users. If applicable, include any specific functionalities or improvements you envision.
|
||||
|
||||
### Alternative Solutions
|
||||
**Describe alternatives you've considered**
|
||||
Have you explored any workarounds or other features that provide similar functionality? Please share your findings, including why these alternatives do not meet your needs fully. This helps us understand the unique value of your proposed enhancement.
|
||||
|
||||
### Use Cases
|
||||
**Identify potential use cases**
|
||||
Who will benefit from this enhancement? Describe specific scenarios in which the enhanced feature would be used. This will help us gauge the enhancement's impact and prioritize its development accordingly.
|
||||
|
||||
### Impact of Enhancement
|
||||
**Explain the potential impact**
|
||||
How would this enhancement improve workflows, productivity, or user experience? Detailing the expected benefits can help stakeholders understand the importance of the enhancement and support its implementation.
|
||||
|
||||
### Visuals and Mockups
|
||||
**Provide any visuals**
|
||||
If you have sketches, wireframes, mockups, or any visual representation of your proposed enhancement, please attach them. Visuals can help convey your ideas more clearly and can be very persuasive in the evaluation process.
|
||||
|
||||
### 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, insights from user feedback, technical considerations, or any other details that could influence the enhancement process.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Performance
|
||||
about: Suggest a performance enhancement for this project
|
||||
title: ""
|
||||
type: Performance
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Performance Improvement Request
|
||||
|
||||
### Performance Issue Overview
|
||||
**Is your performance issue related to a specific functionality? Please describe.**
|
||||
Provide a detailed explanation of the performance issue you are experiencing. Describe the context in which the problem occurs, such as during specific operations or under certain conditions. For example, "The application takes a long time to load images on low-end devices..."
|
||||
|
||||
### Proposed Enhancement
|
||||
**Describe the enhancement you'd like**
|
||||
Explain in detail what you would like to see improved in terms of performance. Describe how this enhancement should work and why it would be a beneficial addition to the software. If possible, include any specific metrics (like time complexity, memory usage) you envision for this enhancement.
|
||||
|
||||
### Alternative Solutions
|
||||
**Describe alternatives you've considered**
|
||||
Have you identified any potential fixes or tweaks yourself? Please share your findings, including why they might not have been a perfect or complete solution. This helps us understand the issue better and consider all possible solutions.
|
||||
|
||||
### Affected Use Cases
|
||||
**Identify affected use cases**
|
||||
Who is most affected by this performance issue? Describe specific scenarios in which this issue impacts usability or efficiency. This will help us understand the importance of the performance enhancement and prioritize its development.
|
||||
|
||||
### Impact of Enhancement
|
||||
**Explain the potential impact**
|
||||
How would this enhancement improve performance, efficiency, or user satisfaction? Detailing the anticipated improvements can help stakeholders understand the significance of the enhancement.
|
||||
|
||||
### Benchmarks and Metrics
|
||||
**Provide any relevant benchmarks or metrics**
|
||||
If you have conducted performance tests, or if there are specific benchmarks that highlight the issue, please include them. Data can be very helpful in illustrating the scope and severity of performance issues.
|
||||
|
||||
### Additional Context
|
||||
**Add any other context**
|
||||
Include any other information that might help clarify your enhancement request. This could be links to relevant literature, technical considerations, or any other details that could inform the enhancement process.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
name: Task
|
||||
about: Suggest a task for this project
|
||||
title: ""
|
||||
type: Task
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Task Request
|
||||
|
||||
### Task Overview
|
||||
**What maintenance task do you propose? Please describe.**
|
||||
Provide a detailed explanation of the maintenance task. This could be upgrading dependencies, refactoring code, improving build processes, or other similar tasks that help keep the project healthy but don't directly add new features or fix bugs.
|
||||
|
||||
### Purpose of the Task
|
||||
**Explain why this task is necessary**
|
||||
Describe the reasons for the maintenance task and its expected benefits, such as improved performance, security enhancements, better developer experience, or future-proofing the project.
|
||||
|
||||
### Potential Issues
|
||||
**Identify any potential issues that might arise from this task**
|
||||
Discuss any challenges or potential disruptions that could occur as a result of this maintenance task. This will help prepare for and mitigate any negative impacts.
|
||||
|
||||
### Impact of Task
|
||||
**Explain the potential impact**
|
||||
Detail how this maintenance task will positively affect the project, such as making it easier to maintain, reducing technical debt, or improving system stability.
|
||||
|
||||
### Additional Context
|
||||
**Add any other context**
|
||||
Include any other information that might help clarify your request. This could be links to similar tasks performed in other projects, specific dependency versions, or technical considerations.
|
||||
Reference in New Issue
Block a user