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

Update issue forms to use YAML templates #71

Merged
merged 10 commits into from
Nov 25, 2024
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]
projects: []
assignees:
- teald
body:
- type: markdown
attributes:
value: |
Thank you for filling out a bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info? If you get notification for GitHub Issues, you can ignore this part.
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: What version of our software are you running?
value: "run `python -c \"import astrodata; print(astrodata.version)\"` to print the version to the terminal. `0.0.0` means you are running the development version!"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GeminiDRSoftware/astrodata/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Documentation issue
description: File an issue related to our documentation.
title: "[DOCS]: "
labels: ["documentation"]
projects: []
assignees:
- teald
body:
- type: markdown
attributes:
value: |
Thank you for filing a documentation issue!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info? If you get notification for GitHub Issues, you can ignore this part.
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: docs-description
attributes:
label: What is up with the docs?
placeholder: Fill out the issue you've found. If this is an error (e.g., typo), a link to the page would be appreciated.
value: "The docs are..."
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GeminiDRSoftware/astrodata/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Feature Request
description: Request a feature
title: "[Feat]: "
labels: ["enhancement"]
projects: []
assignees:
- teald
body:
- type: markdown
attributes:
value: |
Thank you for requesting a new feature! Your input is critical to helping us make `astrodata` even better!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info? If you get notification for GitHub Issues, you can ignore this part.
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: feature-description
attributes:
label: Describe the feature in words
description: "Tell us about your feature request. Example questions to consider: What does it do? How might it be implemented?"
placeholder: I'd like astrodata to...
validations:
required: true
- type: textarea
id: code-description
attributes:
label: code-description
description: If possible, please provide an example code snippet with the feature being used. It doesn't have to run---show us code the way you'd like it to work!
render: shell
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GeminiDRSoftware/astrodata/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/other-issue.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/other_issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Other issue
description: File an issue unrelated to the other templates
title: "[MISC]: "
labels: ["misc"]
projects: []
assignees:
- teald
body:
- type: markdown
attributes:
value: |
Thank you for filling out a bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info? If you get notification for GitHub Issues, you can ignore this part.
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
placeholder: Tell us what you see.
value: "Something happened!"
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GeminiDRSoftware/astrodata/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
Loading