diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..c01a37dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,59 @@ +name: 🐛 File a bug report +description: X's behavior is deviating from its documented behavior. +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please provide the following information. + - type: input + id: Polaris-version + attributes: + label: Polaris version + description: Value of ``polaris.__version__`` + placeholder: 0.2.5, 0.3.0, 0.3.1, etc. + validations: + required: true + - type: input + id: Python-version + attributes: + label: Python Version + description: Version of Python interpreter + placeholder: 3.9, 3.10, 3.11, etc. + validations: + required: true + - type: input + id: OS + attributes: + label: Operating System + description: Operating System + placeholder: (Linux/Windows/Mac) + validations: + required: true + - type: input + id: installation + attributes: + label: Installation + description: How was Polaris installed? + placeholder: e.g., "using pip into virtual environment", or "using conda" + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Explain why the current behavior is a problem, what the expected output/behaviour is, and why the expected output/behaviour is a better solution. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Minimal, reproducible code sample, a copy-pastable example if possible. + validations: + required: true + - type: textarea + id: additional-output + attributes: + label: Additional output + description: If you think it might be relevant, please provide the output from ``pip freeze`` or ``conda env export`` depending on which was used to install Polaris. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..bb5722c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: ❓ Discuss something on GitHub Discussions + url: https://github.com/polaris-hub/polaris/discussions + about: For questions like "How do I do X with Polaris?", you can move to GitHub Discussions. + - name: ❓ Discuss something on Discord + url: https://discord.gg/vBFd8p6H7u + about: For more interactive discussions, you can join our Discord server. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/default-template.md b/.github/ISSUE_TEMPLATE/default-template.md index fa3e4c3b..fa413517 100644 --- a/.github/ISSUE_TEMPLATE/default-template.md +++ b/.github/ISSUE_TEMPLATE/default-template.md @@ -1,6 +1,6 @@ --- name: Default Template -about: Default issue template +about: Default, generic issue template title: '' labels: '' assignees: '' @@ -20,4 +20,4 @@ _Describe the expected work that will be needed to address the issue, leading in # Links -- [Link to other issues/PRs/external tasks](www.example.com) +- [Link to other issues/PRs/external tasks](www.example.com) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..72e16233 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for a new Polaris feature +title: '' +labels: feature +assignees: '' +--- + +# 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. \ No newline at end of file