From d99cff9c64d4ffba3ae00fe90a4c2191dac6cc36 Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 10:55:05 -0800 Subject: [PATCH 01/10] feat(github): Update bug issue template to use YAML --- .github/ISSUE_TEMPLATE/bug_report.yaml | 51 ++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..c0faf1fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -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? + placeholder: ex. email@example.com + 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://example.com). + options: + - label: I agree to follow this project's Code of Conduct + required: true From d2161bbae9c418e95eea0fa52ff6cb0638c48820 Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 11:00:26 -0800 Subject: [PATCH 02/10] fix(github): Use code of conduct link, not example --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index c0faf1fd..af2ea23a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -45,7 +45,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GeminiDRSoftware/astrodata/blob/feature/issue_forms/CODE_OF_CONDUCT.md). options: - label: I agree to follow this project's Code of Conduct required: true From 6420435fed97f1a1024c52b84385ace50cf7a437 Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 11:01:30 -0800 Subject: [PATCH 03/10] fix(github): Remove branch info from link --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index af2ea23a..6e6814da 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -45,7 +45,7 @@ body: 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/feature/issue_forms/CODE_OF_CONDUCT.md). + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GeminiDRSoftware/astrodata/CODE_OF_CONDUCT.md). options: - label: I agree to follow this project's Code of Conduct required: true From 8b7d3c8a4fd1643a50468de02d4b49916e43338a Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 11:02:24 -0800 Subject: [PATCH 04/10] fix(github): Add main branch info to URL --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 6e6814da..e25457c5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -45,7 +45,7 @@ body: 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/CODE_OF_CONDUCT.md). + 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 From d99184027aa7a4505bae8b5110b6205f97504429 Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 11:18:46 -0800 Subject: [PATCH 05/10] feat(github): Add docs issue template YAML --- .github/ISSUE_TEMPLATE/documentation.yaml | 36 +++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 00000000..c3299c15 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -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@example.com + 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 From a745d224684ccf834a190aa40659c40d3450ded6 Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 11:21:20 -0800 Subject: [PATCH 06/10] fix(github): Update contact description to clarify in bug rep --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index e25457c5..abebd5ce 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -14,7 +14,7 @@ body: id: contact attributes: label: Contact Details - description: How can we get in touch with you if we need more info? + 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@example.com validations: required: false From 3302e807a63c26baa3376f4df26072f2fff0c33c Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 12:36:34 -0800 Subject: [PATCH 07/10] feat(github): Feature request issue template YAML --- .github/ISSUE_TEMPLATE/feature_request.yaml | 50 +++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..a438d758 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,50 @@ +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@example.com + 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: 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 From 8aba70076563df3827c8c63919766c2e14c212eb Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 12:37:03 -0800 Subject: [PATCH 08/10] fix(github): Remove log input from feature request template --- .github/ISSUE_TEMPLATE/feature_request.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index a438d758..0d61cc89 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -34,12 +34,6 @@ body: render: shell 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: From 11f2f60e053479bffe22d70f993f4b6d689e88b7 Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 12:43:24 -0800 Subject: [PATCH 09/10] feat(github): Add other issue misc template --- .github/ISSUE_TEMPLATE/other_issue.yaml | 36 +++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/other_issue.yaml diff --git a/.github/ISSUE_TEMPLATE/other_issue.yaml b/.github/ISSUE_TEMPLATE/other_issue.yaml new file mode 100644 index 00000000..a40b912f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issue.yaml @@ -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@example.com + 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 From 0dfa4f033904f0a4f61ec2114082a68583baa16f Mon Sep 17 00:00:00 2001 From: teald Date: Mon, 25 Nov 2024 12:45:03 -0800 Subject: [PATCH 10/10] feat(github): Remove outdated markdown templates --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ----------------------- .github/ISSUE_TEMPLATE/documentation.md | 20 ------------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ------------- .github/ISSUE_TEMPLATE/other-issue.md | 20 ------------- 4 files changed, 95 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/other-issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index f92dced4..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: teald - ---- - -Thank you for finding some behavior indicative of a bug in `astrodata`! Please fill out this form to the best of your ability so we can work on fixing the problem. If you can't fill out a section or are unsure how, you may leave it empty or ask for help. - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps and requirements to reproduce the behavior: -1. import `astrodata` -2. ... - - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Example code** -A minimal example reproducing the behavior (preferably code/command line). - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. Ubuntu, OSX] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index e61ba847..00000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Documentation -about: Requests or problems with astrodata's documentation. -title: "[DOC]" -labels: '' -assignees: teald - ---- - -Thank you for submitting an issue related to our documentation! *If this is a minor change or something you are willing to modify directly yourself, your help would be greatly appreciated!* Please modify the file using your preferred method (e.g., [directly in github](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) or by [making a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)). Otherwise, continue on with this form. - -## Description -[Your idea or issue with the documentation] - -## Solution -[If applicable, your solution to the issue] - -### Urgency -- [ ] This problem should be fixed quickly (urgent) -- [ ] This problem is minor/does not require immediate fixing. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 31c4003a..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE]" -labels: enhancement -assignees: teald - ---- - -**Is your feature request related to a problem? Please describe or write "N/A".** -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. Example code is _highly_ encouraged! - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered, if any. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/other-issue.md b/.github/ISSUE_TEMPLATE/other-issue.md deleted file mode 100644 index a487e3f4..00000000 --- a/.github/ISSUE_TEMPLATE/other-issue.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Other issue -about: Generic template for issues that are not bugs or feature requests. -title: "[OTHER]" -labels: '' -assignees: teald - ---- - -### Describe your issue here. -[e.g., I want to bring up...] - -### Please check all that apply. -- [ ] This issue requires help from someone familiar with `astrodata`. -- [ ] This issue is related to *packaging*. -- [ ] This issue is related to *licensing*. -- [ ] This issue is requesting help with a problem that is unlikely to be a bug. -- [ ] This issue is about structure of the package or formatting in the code. -- [ ] This issue is related to GitHub. -- [ ] This issue is related to PyPI.