Skip to content

Commit

Permalink
Add issue templates (#6986)
Browse files Browse the repository at this point in the history
Add issue templates (forms) to:

- guide authors during issue creation and
- automatically assign labels
  • Loading branch information
ShortDevelopment authored May 23, 2024
1 parent 682026b commit 3a7b120
Show file tree
Hide file tree
Showing 6 changed files with 165 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Bug report
description: Report a general bug in ChakraCore
title: '[Bug]: '
labels:
- Bug
body:
- type: input
attributes:
label: ChakraCore Version
description: Specify the version of ChakraCore you are using
placeholder: Version / Commit id
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Provide steps to reproduce the problem
placeholder: Instructions used to build and execute / Project setup
validations:
required: true
- type: textarea
attributes:
label: Proof of concept
description: Your POC code
render: js
validations:
required: true
- type: textarea
attributes:
label: Exception or Error
description: Provide error logs / console output
render: text
validations:
required: true
- type: textarea
attributes:
label: Additional Context
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/02-build-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Build Issue
description: Report a build issue
title: '[Build]: '
labels:
- Build Break
body:
- type: input
attributes:
label: Operating System
description: Specify the OS (with version) you are using
placeholder: Name + Version
validations:
required: true
- type: input
attributes:
label: Compiler
description: Specify the compiler (with version) you are using
placeholder: Name + Version
validations:
required: true
- type: input
attributes:
label: ChakraCore Version
description: Specify the version of ChakraCore you are using
placeholder: Version / Commit id
validations:
required: true
- type: textarea
attributes:
label: Compiler output
render: shell
validations:
required: true
- type: textarea
attributes:
label: Additional Context
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/03-jsrt-bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Api Bug
description: Report a bug with the embedding api
title: '[Api]: '
labels:
- APIs
- Bug
body:
- type: input
attributes:
label: Operating System
description: Specify the OS (with version) you are using
placeholder: Name + Version
validations:
required: true
- type: input
attributes:
label: ChakraCore Version
description: Specify the version of ChakraCore you are using
placeholder: Version / Commit id
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Please describe how your project is set-up
validations:
required: true
- type: textarea
attributes:
label: Proof of concept
description: Add some minimal poc that triggers the bug
render: cpp
validations:
required: true
- type: textarea
attributes:
label: Additional context
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/04-jsrt-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Api Feature Request
description: Propose a new feature to the embedding api
title: '[Api]: '
labels:
- APIs
- Feature Request
body:
- type: textarea
attributes:
label: Description
description: A clear and concise description of the problem or missing capability
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: If you have a solution in mind, please describe it.
- type: textarea
attributes:
label: Describe alternatives you've considered
description: Have you considered any alternative solutions or workarounds?
- type: textarea
attributes:
label: Additional context
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/05-tc39-proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Implement tc39 proposal
description: Request the implementation of a tc39 proposal
title: '[Proposal]: '
labels:
- ECMAScript Spec
- Feature Request
body:
- type: input
attributes:
label: Link to proposal
placeholder: https://github.com/tc39/...
validations:
required: true
- type: dropdown
attributes:
label: Proposal stage
options:
- Stage 4
- Stage 3
- Stage 2.7
- Stage 2
validations:
required: true
- type: textarea
attributes:
label: Additional Context
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Discord
url: https://discord.gg/dgRawPdNuC
about: If you have any questions, feel free to join our Discord server.

0 comments on commit 3a7b120

Please sign in to comment.