-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
248 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| labels: [question] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for your interest in zppy! Please follow the template below to ensure the development team and community can help you effectively. | ||
|
|
||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Question criteria | ||
| description: Please confirm and check all the following options. | ||
| options: | ||
| - label: I added a descriptive title here. | ||
| required: true | ||
| - label: I searched the [zppy GitHub Discussions](https://github.com/E3SM-Project/zppy/discussions) to find a similar question and didn't find it. | ||
| required: true | ||
| - label: I searched the [zppy documentation](https://e3sm-project.github.io/zppy). | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: your-question | ||
| attributes: | ||
| label: Describe your question | ||
| description: | | ||
| Please help the community help you. The more specific you can be, the easier it will be to help. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: possible-answers | ||
| attributes: | ||
| label: Are there are any possible answers you came across? | ||
| description: | | ||
| This will help others determine if you're on the right track. Include links to pages you've researched (e.g., software docs, Stack Overflow posts). | ||
|
|
||
| - type: textarea | ||
| id: machine | ||
| attributes: | ||
| label: What machine were you running on? | ||
| description: | | ||
| List the machine(s) you encounter the issue on (e.g., Chrysalis, Compy, Perlmutter). | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: zppy-version | ||
| attributes: | ||
| label: Environment | ||
| description: | | ||
| Paste your zppy version here (e.g., `zppy v2.3.0`). | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: zppy-command | ||
| attributes: | ||
| label: What command did you run? | ||
| description: | | ||
| Copy the command causing the issue (e.g., `zppy -c tests/integration/generated/test_complete_run_chrysalis.cfg`). This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: cfg-file | ||
| attributes: | ||
| label: Copy your cfg file | ||
| description: | | ||
| Copy the contents of your cfg file into the space below. This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: status-output | ||
| attributes: | ||
| label: What jobs are failing? | ||
| description: | | ||
| Go to the `output` line of your cfg. `cd` into `post/scripts`. Copy the output of `grep -v "OK" *status`. This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: stack-trace | ||
| attributes: | ||
| label: What stack trace are you encountering? | ||
| description: | | ||
| Copy a stack trace from one of your failing jobs. This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| name: Bug Report | ||
| description: File a bug report to help us improve zppy | ||
| title: "[Bug]: " | ||
| labels: ["semver: bug"] | ||
| assignees: [] | ||
| body: | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: | | ||
| Thanks for reporting a bug! Please describe what you were trying to get done. | ||
| Tell us what happened and what went wrong. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: machine | ||
| attributes: | ||
| label: What machine were you running on? | ||
| description: | | ||
| List the machine(s) you encounter the issue on (e.g., Chrysalis, Compy, Perlmutter). | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: zppy-version | ||
| attributes: | ||
| label: Environment | ||
| description: | | ||
| Paste your zppy version here (e.g., `zppy v2.3.0`). | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: zppy-command | ||
| attributes: | ||
| label: What command did you run? | ||
| description: | | ||
| Copy the command causing the issue (e.g., `zppy -c tests/integration/generated/test_complete_run_chrysalis.cfg`). This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: cfg-file | ||
| attributes: | ||
| label: Copy your cfg file | ||
| description: | | ||
| Copy the contents of your cfg file into the space below. This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: status-output | ||
| attributes: | ||
| label: What jobs are failing? | ||
| description: | | ||
| Go to the `output` line of your cfg. `cd` into `post/scripts`. Copy the output of `grep -v "OK" *status`. This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: stack-trace | ||
| attributes: | ||
| label: What stack trace are you encountering? | ||
| description: | | ||
| Copy a stack trace from one of your failing jobs. This will be automatically formatted into code, so no need for markdown backticks. | ||
| render: bash | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: Questions (zppy) | ||
| url: https://github.com/E3SM-Project/zppy/discussions | ||
| about: | | ||
| Ask questions and discuss with other zppy community members here. Please | ||
| browse the zppy Discussions Forum or zppy documentation first before asking a | ||
| question to make sure it is not already answered. If you can't find an | ||
| answer, please include a self-contained reproducible example with your | ||
| question if possible. Thanks! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| name: Documentation Update | ||
| description: Update xCDAT documentation | ||
| title: "[Doc]: " | ||
| labels: ["Documentation"] | ||
| assignees: [] | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Describe your documentation update | ||
| description: | | ||
| Concise description of why the documentation is being updated (e.g., missing content for new feature, typo) | ||
| If this is related to an issue or PR, please mention it. | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| name: Feature Request | ||
| description: Suggest an idea for zppy | ||
| title: "[Feature]: " | ||
| labels: [] | ||
| assignees: [] | ||
| body: | ||
| - type: dropdown | ||
| id: semver-level | ||
| attributes: | ||
| label: How will this affect the next version number? | ||
| description: | | ||
| `zppy` uses semantic versioning (https://semver.org/). Bug fixes and small improvements will increment the PATCH version. New features will increment the MINOR version. Incompatible API changes will increment the MAJOR version. The amount of work required to implement a request typically increases with each level. (For bug fixes, use the "Bug Report" template). | ||
| multiple: false | ||
| options: | ||
| - Small improvement (increment PATCH version) | ||
| - New feature (increment MINOR version) | ||
| - Incompatibile API change (increment MAJOR version) | ||
| default: 1 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Is your feature request related to a problem? | ||
| description: | | ||
| Please do a quick search of existing issues to make sure that this has not been asked before. | ||
| Please provide a clear and concise description of what the problem is. E.g., I'm always frustrated when [...] | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Describe the solution you'd like | ||
| description: | | ||
| A clear and concise description of what you want to happen. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Describe alternatives you've considered | ||
| description: | | ||
| A clear and concise description of any alternative solutions or features you've considered. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional context | ||
| description: | | ||
| Add any other context about the feature request here. | ||
| validations: | ||
| required: false |