diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..210a32d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +# Bug report + +## Describe the bug + +A clear and concise description of what the bug is. + +## To Reproduce + +Steps to reproduce the behavior. +If applicable include the code you tried to run. In case you do, please try +to minimize the code example to the least amount of code required to trigger +the bug. + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Screenshots + +If applicable, add screenshots to help explain your problem. + +## Operating System (please complete the following information) + +- OS: [e.g. Linux] +- Version [e.g. 22.04 LTS] +- Distribution [e.g. Ubuntu] + +## Additional context + +Add any other context about the problem here: + +- Python version (`python --version`) and distribution: +- List of installed packages (`pip list` or equivalent): +- Anything else that might be relevant diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..38e99bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,37 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +# Feature request + +## Is your feature request related to a problem? Please describe + +A clear and concise description of what the problem is, for example: + +As a [...] I want [...] so that [...] + +## 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. + +## Acceptance criteria + +Please specify the acceptance criteria in as much detail as possible, +for example: + +- if this feature is available how would you invoke it (code example) +- what would the output look like? + - if it is an object, what would the members be? + - if it is a plot, a sketch would help + - anything else that clarifies what would constitute a satisfactory + implementation? + +## Additional context + +Add any other context or screenshots about the feature request here.