Skip to content

Commit

Permalink
Template refresh (#612)
Browse files Browse the repository at this point in the history
* form-ified bug report issue template

* PR template refresh

* add general issue

* some more forms

* feature request

* does this work?

* sync from preview

* remove old templates

* remove one more bit from PR template

* add to release notes

* switch out that line, too, for a link to the contrib guide

* update links in contrib, this will fail until merged

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>

* add @kafitzgerald comments

* oops forgot that one

* remove functionality module line

---------

Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>
  • Loading branch information
anissa111 and kafitzgerald authored May 2, 2024
1 parent 2a90fad commit 865e2f9
Show file tree
Hide file tree
Showing 10 changed files with 202 additions and 97 deletions.
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: 🐛 Bug report
description: File a bug report
title: "[🐛]: "
labels: ["bug", "support", "triage"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: "Version"
description: "What version of geocat-comp are you running?"
placeholder: "v2024.01.0"
validations:
required: true

- type: dropdown
id: installation
attributes:
label: "How did you install geocat-comp?"
multiple: false
options:
- conda-forge
- pip
- source
- pre-made maintained environment
- other (please explain in your summary below)
validations:
required: true

- type: input
id: os
attributes:
label: "Operating System"
description: "What operating system are you using?"
placeholder: "Example: macOS Big Sur"
validations:
required: true

- type: textarea
id: summary
attributes:
label: "Summary"
description: "Please provide a summary of the issue"
validations:
required: true

- type: textarea
id: expected
attributes:
label: "Expected behavior"
description: "What did you expect to happen?"
validations:
required: false

- type: textarea
id: reproduce
attributes:
label: "Steps to reproduce"
description: "If possible, please provide a minimal reproducible example that demonstrates the problem."
validations:
required: false

- type: textarea
id: log-output
attributes:
label: "Relevant log output"
description: "If applicable, please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks"
render: Python
validations:
required: false

- type: textarea
id: environment
attributes:
label: "Environment"
description: "If possible, please paste the output of `conda list` or `pip freeze` between the <details> tags, leaving an empty line following the opening tag."
value: |
<details>
</details>
validations:
required: false
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 💡 Feature request
description: Suggest an idea for this project
title: "[💡]: "
labels: ["feature", "support", "triage"]

body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this feature request!"

- type: textarea
id: summary
attributes:
label: "Describe the functionality you are requesting, linking any relevant usage or previous implementations in the python ecosystem or otherwise."
description: "the more information the better!"
validations:
required: true

- type: dropdown
id: ncl
attributes:
label: "Is this a request for functionality that was previously in NCL?"
options:
- "Yes"
- "No"
- "Unknown"
validations:
required: true

- type: textarea
id: additional
attributes:
label: "Additional context"
description: "Add any other context or screenshots about the feature request here"
validations:
required: false
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/general_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: 📝 Issue
description: General issue that's not a bug report
title: "[Issue]: "
labels: ["triage"]

body:
- type: markdown
attributes:
value: "Thank you for taking the time to fill out this issue!"

- type: textarea
id: summary
attributes:
label: "Please describe your issue here"
validations:
required: true
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/release.md

This file was deleted.

45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: ✅ Release request
description: Request a new release of geocat-comp
title: "[Release]: vYYYY.MM.##"
labels: ["release", "high-priority"]
assignees: "anissa111"

body:
- type: input
id: version
attributes:
label: "Version"
placeholder: "vYYYY.MM.##"
validations:
required: true

- type: input
id: date
attributes:
label: "Intended release date"
description: "When is this release supposed to be published?"
placeholder: "January 1, 1970"
validations:
required: false

- type: textarea
id: summary
attributes:
label: "Summary"
description: "Plain text summary of significant changes"
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: "Release progress checklist"
description: "After submitting this issue, please check off each item as it is completed."
options:
- label: release-notes.rst has been updated with latest release notes, version, and release date
- label: CI tests are passing
- label: a new tag and release has been made on GitHub
- label: feedstock PR has been merged
- label: new version can be installed via conda
- label: release on pypi action has been triggered on the tag
- label: new version can be installed via pip
36 changes: 13 additions & 23 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,27 @@
## PR Summary
<!-- Summary goes here. Replace XXX with the number of the issue this PR will resolve. -->

## Related Tickets & Documents
Closes #XXX

## PR Checklist
<!-- Please mark any checkboxes that do not apply to this PR as [N/A]. If an entire section doesn't
apply to this PR, comment it out or delete it. -->
**General**
- [ ] Make an issue if one doesn't already exist
- [ ] Link the issue this PR resolves by adding `closes #XXX` to the PR description where XXX is the number of the issue.
- [ ] Add a brief summary of changes to `docs/release-notes.rst` in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecated
- [ ] PR includes a summary of changes
- [ ] Link relevant issues, make one if none exist
- [ ] Add a brief summary of changes to `docs/release-notes.rst` in a relevant section for the upcoming release.
- [ ] Add appropriate labels to this PR
- [ ] Make your changes in a forked repository rather than directly in this repo
- [ ] Open this PR as a draft if it is not ready for review
- [ ] Convert this PR from a draft to a full PR before requesting reviewers
- [ ] Passes `precommit`. To set up on your local, run `pre-commit install` from the top level of the repository. To manually run pre-commits, use `pre-commit run --all-files` and re-add any changed files before committing again and pushing.
- [ ] If needed, squash and merge PR commits into a single commit to clean up commit history
- [ ] PR follows the [Contributor's Guide](https://geocat-comp.readthedocs.io/en/stable/contrib.html)

**Functionality**
- [ ] Function is in appropriate module file
- [ ] New function(s) intended for public API added to `geocat/comp/__init__.py` file

**Testing**
- [ ] Tests for function exists in associated module test file
- [ ] Tests cover all possible logical paths in your function
- [ ] Update or create tests in appropriate test file

**Documentation**
- [ ] Docstrings have been added to all new functions ([Documentation Standards](https://geocat-comp.readthedocs.io/en/stable/contrib.html#docstrings))
- [ ] Docstrings have updated with any function changes
- [ ] Docstrings have been created and/or updated in accordance with [Documentation Standards](https://geocat-comp.readthedocs.io/en/stable/contrib.html#docstrings).
- [ ] Internal functions have a preceding underscore (`_`) and have been added to `docs/internal_api/index.rst`
- [ ] User facing functions have been added to `docs/user_api/index.rst` under their module

**Examples**
- [ ] Any new notebook examples added to `docs/examples/` folder
- [ ] Pre-run all notebook cells
- [ ] New notebook files added to `docs/examples.rst` toctree
- [ ] New notebook files added to new entry in `docs/gallery.yml` with appropriate thumbnail photo in `docs/_static/thumbnails/`


<!--
Thank you so much for your PR! To help us review your contribution, please
Expand All @@ -59,12 +45,16 @@ consider the following points:
name and GitHub link to bottom of `docs/release-notes.rst` as _`FirstName LastName`
:https://github.com/githubUsername
- When merging, we prefer to use squash commits.
- You can install pre-commit hooks and then run them locally with `pre-commit run --all-files`
**PR Etiquette Reminders**
- This PR should be listed as a draft PR until you are ready to request reviewers
- After making changes in accordance with the reviews, re-request your reviewers
- Do *not* mark conversations as resolved if you didn't start them
- Generally, don't mark conversations as resolved if you didn't open them
- Do mark conversations as resolved *if you opened them* and are satisfied with the changes/discussion.
Expand Down
4 changes: 2 additions & 2 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Reporting bugs

Something not working as expected? We would love to hear about it! Please report
any bugs you find by opening an issue on GitHub. See our `bug report template
<https://github.com/NCAR/geocat-comp/issues/new?assignees=&labels=bug%2C+support&projects=&template=bug_report.md&title=>`__
<https://github.com/NCAR/geocat-comp/issues/new?assignees=&labels=bug%2Csupport%2Ctriage&projects=&template=bug_report.yml&title=%5B%F0%9F%90%9B%5D%3A+>`__
to get started.

When reporting a bug, please include as much information as possible. This will
Expand All @@ -59,7 +59,7 @@ Requesting new features

Have an idea for a new feature? Want to know how to do something in Python that
you used to do in NCL? See our `feature request template
<https://github.com/NCAR/geocat-comp/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=>`__
<https://github.com/NCAR/geocat-comp/issues/new?assignees=&labels=feature%2Csupport%2Ctriage&projects=&template=feature_request.yml&title=%5B%F0%9F%92%A1%5D%3A+>`__
to get started.

You can also use our `Feature Request Form
Expand Down
1 change: 1 addition & 0 deletions docs/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Internal Changes
* Update and setup autoupdate for pre-commit hooks by `Cora Schneck`_ in (:pr:`604`)
* Removed ``pre-commit.yaml`` action in favor of pre-commit.ci by `Cora Schneck`_ in (:pr:`608`)
* Remove ASV version pin and pin Conda version for benchmarking workflow by `Katelyn FitzGerald`_ in (:pr:`610`)
* Updates to issue and PR templates by `Anissa Zacharias`_ in (:pr:`612`)

v2024.04.0 (April 23, 2024)
---------------------------
Expand Down

0 comments on commit 865e2f9

Please sign in to comment.