tuscland
commented
1 week ago - [ ] Merge relevant part with scikit-learn's issue templates (see https://github.com/scikit-learn/scikit-learn/issues/new/choose).
- [ ] Add links to other channels (Discord).
Open tuscland opened 1 week ago
tuscland
commented
1 week ago
In preparation for the public beta, and in order to onboard users, we would like the following issue templates:
Here are initial propositions:
Bug Report
Description
A clear and concise description of the bug.
Steps to Reproduce
Expected Behavior
A clear and concise description of what you expected to happen.
Actual Behavior
A clear and concise description of what actually happened.
Environment
python3 -m skore --version):Additional Context
Add any other context about the problem here. If applicable, add screenshots to help explain your problem.
Possible Solution
If you have any ideas on how to solve the issue, please describe them here.
Feature Request
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Describe the solution you'd like
A clear and concise description of what you want to happen.
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context or screenshots about the feature request here.
Impact
How would this feature benefit the skore community and data scientists in general?
Documentation Improvement
Which part of the documentation needs improvement?
Provide a link to the documentation page and section, if possible.
Describe the problem
A clear and concise description of what is unclear, missing, or incorrect in the current documentation.
Suggested improvement
A clear and concise description of how you think the documentation could be improved.
Additional context
Add any other context about the documentation improvement here.
Your expertise level
Are you a beginner, intermediate, or advanced user of skore? This helps us gauge the appropriate level of detail for the documentation.
Chore
Description
A clear and concise description of the chore or maintenance task.
Motivation
Explain why this chore is necessary. How will it improve the project?
Proposed Changes
Outline the specific changes or steps needed to complete this chore.
Areas Affected
List the parts of the project that will be affected by this chore (e.g., specific modules, documentation, build process).
Checklist
Additional Context
Add any other context about the chore here. This could include links to related issues, pull requests, or external resources.
Estimated Effort
Provide a rough estimate of the time or complexity involved in completing this chore (e.g., small, medium, large).
Priority
Indicate the priority level of this chore (e.g., low, medium, high).