Skip to content

Commit

Permalink
Add GitHub issues and pull request templates (#221)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvothecoder authored Oct 11, 2023
1 parent a98b696 commit 3b8b89b
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 1 deletion.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug Report
description: File a bug report to help us improve e3sm_to_cmip
title: "[Bug]: "
labels: ["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, what went wrong.
validations:
required: true

- type: textarea
id: what-did-you-expect-to-happen
attributes:
label: What did you expect to happen? Are there are possible answers you came across?
description: |
Describe what you expected to happen. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).
validations:
required: false

- type: textarea
id: sample-code
attributes:
label: Minimal Complete Verifiable Example (MVCE)
description: |
Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly. This section will be automatically formatted into code, so no need for markdown backticks.
See guidelines below on how to provide a good MCVE:
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
render: python

- type: textarea
id: log-output
attributes:
label: Relevant log output
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
render: python

- type: textarea
id: extra
attributes:
label: Anything else we need to know?
description: |
Please describe any other information you want to share.
- type: textarea
id: show-versions
attributes:
label: Environment
description: |
Paste your conda environment here (`conda info`).
validations:
required: true
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
blank_issues_enabled: true
contact_links:
- name: Questions
url: https://github.com/E3SM-Project/e3sm_to_cmip/discussions
about: |
Ask questions and discuss with other e3sm_to_cmip community members here. Please
browse the e3sm_to_cmip Discussions Forum or e3sm_to_cmip 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!
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Documentation Update
description: Update e3sm_to_cmip 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
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Suggest an idea for e3sm_to_cmip
title: "[Feature]: "
labels: ["enhancement"]
assignees: []
body:
- 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. Ex. 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
2 changes: 1 addition & 1 deletion .github/workflows/build_workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:

env:
CANCEL_OTHERS: true
PATHS_IGNORE: '["**/README.md", "**/docs/**", "**/examples/**", "**/misc/**", "**/.vscode/**"]'
PATHS_IGNORE: '["**/README.md", "**/docs/**", "**/examples/**", "**/misc/**", "**/.vscode/**", "**/ISSUE_TEMPLATE/**", "**/pull_request_template.md"]'

jobs:
build:
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Description

<!--
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
-->

- Closes #<ISSUE_NUMBER_HERE>

## Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published in downstream modules

If applicable:

- [ ] New and existing unit tests pass with my changes (locally and CI/CD build)
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

0 comments on commit 3b8b89b

Please sign in to comment.