diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..baa74d7c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,34 @@ +name: Bug Report +description: Report a bug related to WeatherGenerator. +labels: ["bug"] +body: + - type: textarea + id: what-happened + attributes: + label: What happened? + description: | + Expected Results: What was supposed to happen? + + Actual Results: What happened when you got the bug? + + Additional Information: Add anything else you feel we need to know e.g. The exact error message printed + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: What are the steps to reproduce the bug? + description: | + Minimal steps to reproduce the behavior: + - code branch with ALL configuration files + - HPC + - run_id + - command run + - if applicable: node configuration + validations: + required: "false" + - type: input + id: data + attributes: + label: Hedgedoc link to logs and more information. This ticket is public, do not attach files directly. + description: Please put all relevant information (logs, plots, etc.) in the Hedgedoc and link it here. diff --git a/.github/ISSUE_TEMPLATE/initiative.yml b/.github/ISSUE_TEMPLATE/initiative.yml new file mode 100644 index 00000000..624f0d68 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/initiative.yml @@ -0,0 +1,53 @@ +name: Initiative +description: A piece of work that will likely take more than a week to complete. +title: "[ISSUE] " +labels: ["initiative"] + +body: + - type: markdown + attributes: + value: | + Describe the task. It can be a feature, a set of experiments, documentation, etc. + + Be specific and provide context. + + Tips for writing good initiatives: + https://gitlab.jsc.fz-juelich.de/esde/WeatherGenerator-private/-/wikis/Design-docs/Writing-a-design-doc + + - type: input + id: hedgedoc_url + attributes: + label: Hedgedoc URL, if you are keeping notes, plots, logs in hedgedoc. + description: Hedgedoc URL, if you are keeping notes, plots, logs in hedgedoc. + placeholder: "https://gitlab.jsc.fz-juelich.de/hedgedoc/..." + validations: + required: false + + + - type: input + id: design_url + attributes: + label: URL to the design document + description: Paste a link to logs, screenshots, or related resources + placeholder: "" + validations: + required: false + + + - type: checkboxes + id: area + attributes: + label: Area + description: The general area this task relates to. + options: + - label: datasets, data readers, data preparation and transfer + - label: model + - label: science + - label: infrastructure and engineering + - label: evaluation, export and visualization + - label: documentation + validations: + required: true + + + diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 00000000..ea4c1604 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,38 @@ +name: Task / Issue +description: A task or issue that should take less than a week to complete. +title: "[ISSUE] " + +body: + - type: markdown + attributes: + value: | + Describe the task. It can be a feature, documentation, etc. + + Be specific and provide context. + + - type: input + id: hedgedoc_url + attributes: + label: Hedgedoc URL, if you are keeping notes, plots, logs in hedgedoc. + description: Paste a link to logs, screenshots, or related resources + placeholder: "https://gitlab.jsc.fz-juelich.de/hedgedoc/..." + validations: + required: false + + - type: checkboxes + id: area + attributes: + label: Area + description: The general area this task relates to. + options: + - label: datasets, data readers, data preparation and transfer + - label: model + - label: science + - label: infrastructure and engineering + - label: evaluation, export and visualization + - label: documentation + validations: + required: true + + +