diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 387c85d7..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' ---- - - -### Summary - - - -### Setup - - - -- OS: [e.g. Linux/MacOS/Windows] -- Python Version: [e.g. v3.x] - -### Steps to reproduce - - - -### What is the current *bug* behavior? - - - -### What is the expected *correct* behavior? - - - -### Relevant logs and/or screenshots - - - -### Possible fixes - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..f300f234 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,82 @@ +name: Bug Report +description: Report a bug or issue with pyKVFinder. +title: "[Bug]: " +body: + - type: textarea + id: summary + attributes: + label: Bug summary + description: Concisely describe the encountered bug. + placeholder: Describe the bug in 1-2 short sentences. + value: + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Code for reproduction + description: | + If possible, please provide a minimum self-contained example. + placeholder: Paste your code here. This field is automatically formatted as Python code. + render: python + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual outcome + description: | + Paste the output produced by the provided code (e.g., console output, images, screenshots). + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected outcome + description: Describe what you expected the code to produce. + validations: + required: true + - type: textarea + id: details + attributes: + label: Additional information + description: | + - What are the conditions under which this bug happens? input parameters, edge cases, etc? + - Has this worked in earlier versions? + - Do you know why this bug is happening? + - Do you maybe even know a fix? + - type: input + id: operating-system + attributes: + label: Operating system + description: Specify your operating system (e.g., Ubuntu, OS/X, Windows). + - type: input + id: python-version + attributes: + label: Python version + description: Check your Python version by running `python --version` in the console. + - type: input + id: pyKVFinder-version + attributes: + label: pyKVFinder Version + description: "From Python prompt: `import pyKVFinder; print(pyKVFinder.__version__)`" + validations: + required: true + - type: input + id: numpy-version + attributes: + label: Numpy Version + description: "From Python prompt: `import numpy; print(numpy.__version__)`" + - type: input + id: jupyter-version + attributes: + label: Jupyter version + description: "In console: `jupyter notebook --version` or `jupyter lab --version`" + - type: dropdown + id: install + attributes: + label: Installation + description: How did you install pyKVFinder? + options: + - pip + - from source diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..38bc459a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,32 @@ +name: Documentation +description: Create a report to help us improve the documentation +title: "[Doc]: " +labels: [documentation] +body: + - type: input + id: link + attributes: + label: Documentation Link + description: | + Link to any documentation or examples that you are referencing. + Suggested improvements should be based on the development version of the docs: [pyKVFinder Documentation](https://lbc-lnbio.github.io/pyKVFinder/) + placeholder: https://lbc-lnbio.github.io/pyKVFinder/... + - type: textarea + id: problem + attributes: + label: Problem + description: What is missing, unclear, or wrong in the documentation? + placeholder: | + * I found [...] to be unclear because [...] + * [...] made me think that [...] when really it should be [...] + * There is no example showing how to do [...] + validations: + required: true + - type: textarea + id: improvement + attributes: + label: Suggested improvement + placeholder: | + * This line should be be changed to say [...] + * Include a paragraph explaining [...] + * Add a figure showing [...] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 3e671245..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Feature Request -about: Fill out this request to help our development team to evaluate your feature proposal -title: '' -labels: '' -assignees: '' - ---- - - - -### Release notes - - - -### Problem to solve - - - -### Intended users - - - -### Proposal - - - -### Further details - - - -### What does success look like, and how can we measure that? - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..1a5d87aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,25 @@ +name: Feature Request +description: Suggest something to add to pyKVFinder! +title: "[ENH]: " +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Please search the [issues](https://github.com/LBC-LNBio/pyKVFinder/issues) for relevant feature requests before creating a new feature request. + - type: textarea + id: problem + attributes: + label: Problem + description: Briefly describe the problem this feature will solve. (2-4 sentences). + placeholder: | + * I'm always frustrated when [...] because [...] + * I would like it if [...] happened when I [...] because [...] + * Here is a sample image of what I am asking for [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed solution + description: Describe a way to accomplish the goals of this feature request. diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml new file mode 100644 index 00000000..5eecef2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -0,0 +1,17 @@ +name: Maintenance +description: Help improve performance, usability and/or consistency. +title: "[MNT]: " +labels: [enhancement] +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Please provide 1-2 short sentences that succinctly describes what could be improved. + validations: + required: true + - type: textarea + id: fix + attributes: + label: Proposed fix + description: Please describe how you think this could be improved.