Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create issue templates #371

Closed
8 tasks
tuscland opened this issue Sep 23, 2024 · 1 comment · Fixed by #428
Closed
8 tasks

Create issue templates #371

tuscland opened this issue Sep 23, 2024 · 1 comment · Fixed by #428
Assignees
Labels
chore Internal enhancement work to be done

Comments

@tuscland
Copy link
Member

tuscland commented Sep 23, 2024

In preparation for the public beta, and in order to onboard users, we would like the following issue templates:

  • bug report
  • feature request
  • documentation improvement
  • chores

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

  • skore version (the output of python3 -m skore --version):
  • Python version:
  • Operating System:
  • Any other relevant software versions:

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

  • This chore is backwards compatible
  • This chore requires updates to the documentation
  • This chore requires updates to the tests
  • This chore affects the project's dependencies

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).

@tuscland
Copy link
Member Author

tuscland commented Sep 23, 2024

@tuscland tuscland self-assigned this Sep 26, 2024
@tuscland tuscland added the chore Internal enhancement work to be done label Oct 1, 2024
tuscland added a commit that referenced this issue Oct 2, 2024
@tuscland tuscland linked a pull request Oct 2, 2024 that will close this issue
thomass-dev pushed a commit that referenced this issue Oct 3, 2024
thomass-dev pushed a commit that referenced this issue Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Internal enhancement work to be done
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant