Skip to content

Commit

Permalink
docs: upgrade to .yml based issue-templates (#2278)
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey committed Sep 17, 2024
1 parent 073434c commit c50bee9
Show file tree
Hide file tree
Showing 8 changed files with 81 additions and 195 deletions.
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bug report
description: File a bug report
labels: 'category: bug'
body:
- type: markdown
attributes:
value: |
Please ensure that the bug has not already been filed in the issue tracker.
Thanks for taking the time to report this bug!
- type: checkboxes
attributes:
label: Have you ensured that all of these are up to date?
options:
- label: Ape
- label: Ape plugins
- type: input
attributes:
label: What version of Ape are you on?
placeholder: "Run `ape --version` and paste the output here"
- type: input
attributes:
label: What command(s) is the bug in?
description: Leave empty if not relevant
placeholder: "For example: ape test"
- type: dropdown
attributes:
label: Operating System
description: What operating system are you on?
options:
- Windows
- macOS (Intel)
- macOS (Apple Silicon)
- Linux
validations:
required: true
- type: textarea
attributes:
label: ape-config.yaml file
description: "Please paste your `ape-config.yaml` contents here (NOTE: do not post anything private like RPC urls or secrets!)"
placeholder: "Run `cat ape-config.yaml` and copy and paste the result here"
validations:
required: true
- type: textarea
attributes:
label: Reproduction code
description: Please include a simple reproduction code-snippet.
validations:
required: true
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature Request
description: Request a new feature, or an improvement to existing functionality.
labels: 'category: feature'

body:
- type: textarea
id: describe
attributes:
label: Describe
description: "Provide a simple overview of what you wish to see added."
placeholder: |
I am trying to ...
Ape's current functionality is inadequate because ...
validations:
required: false
- type: textarea
id: specification
attributes:
label: Specification
description: |
Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better!
Remember, your feature is much more likely to be included if it does not involve any breaking changes.
validations:
required: false
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: |
Include links to any open issues that must be resolved before this feature can be implemented.
validations:
required: false
47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE/work-item.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

64 changes: 0 additions & 64 deletions SECURITY.md

This file was deleted.

0 comments on commit c50bee9

Please sign in to comment.