Skip to content

Commit

Permalink
Update issue templates to use the new yaml system
Browse files Browse the repository at this point in the history
- Also add a template for releases, to help everything that
  needs to be done
  • Loading branch information
lojack5 committed Oct 8, 2024
1 parent e015972 commit 7089e9d
Show file tree
Hide file tree
Showing 6 changed files with 119 additions and 58 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature Request
description: Request new functionality.
title: "[REQUEST]: "
labels: ["enhancement"]
assignees:
- lojack5
body:
- type: markdown
attributes:
value: |
Not quite everything you need in `structured`? Tell us how we can improve it!
- type: textarea
id: feature
attributes:
label: Description
description: Let us know the feature you're looking for, and how it'd work.
validations:
required: true
- type: textarea
id: usecase
attributes:
label: Use
description: Let us know what the feature would be useful for. This could be your specific use case, or even other ways it could be used.
- type: textarea
id: more
attributes:
label: Anything else?
description: If there are any other details, feel free to let us know.
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug Report
description: File a bug report.
title: "[BUG]: "
labels: ["bug"]
assignees:
- lojack5
body:
- type: markdown
attributes:
value: |
So you found something wrong with `structured`. Some information will help us diagnose and fix it.
- type: textarea
id: reproducer
attributes:
label: Reproducer
description: Give a detailed explanation on how to reproduce the bug, as well as expected behavior and actual behavior.
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: What operation system(s) do you observe this bug on?
multiple: true
options:
- Windows
- Linux
- iOS
- Other (specify)
validations:
required: true
- type: input
id: os-text
attributes:
label: Other
description: If your operating system isn't listed, or a more specific operating system if the bug doesn't happen on all versions.
placeholder: ex. Ubunto Linux 24.04.1 LTS
- type: dropdown
id: python
attributes:
label: Python Version
multiple: true
options:
- Python 3.9
- Python 3.10
- Python 3.11
- Python 3.12
- Other (specify)
validations:
required: true
- type: input
id: python-text
attributes:
label: Other
description: If your Python version isn't listed, or a more specific version (for example, only on Python 3.10.4).
placeholder: ex. Pypy 3.10
- type: input
id: structured
attributes:
label: structured version
description: What version of structured does the error happen on? Note if it doesn't happen on the latest release, we may not address the bug.
placeholder: 3.1.0
validations:
required: true
- type: textarea
id: more-info
attributes:
label: Additional Information
description: Provide any additional information you feel is needed to understand this bug.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/3-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Prepare a Release
about: For developers, to aid in preparing a new release.
title: "[RELEASE]: "
---

A checklist of things that need to be done for a release:
- [ ] Create a release branch `release-<version>`
- [ ] Update documentation if needed
- [ ] Update the version string in `structured/__init__.py`
- [ ] Check for any needed updates from dependencies and update:
- [ ] `pyproject.toml`
- [ ] `requirements.txt`
- [ ] `requirements-tests.txt`
- [ ] Update PyPi information in `pyproject.toml` with other needed changes (ex: supported Python versions)
- [ ] Create a Pull Request for all of these updates.
- [ ] Verify all tests pass.
- [ ] Merge the changes into `main`.
- [ ] [Create the distributables](https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives): `py -m build`
- [ ] [Upload the distributables to PyPi](https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives) `py -m twine upload`
- [ ] Create a release on Github from the head of `main`.
- [ ] Close this issue.
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 7089e9d

Please sign in to comment.