Skip to content

Commit

Permalink
create issues template
Browse files Browse the repository at this point in the history
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed Feb 25, 2023
1 parent 70eeeff commit 1e0c536
Show file tree
Hide file tree
Showing 5 changed files with 239 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,14 @@
---
name: Bug report
about: Report a mistake or inconsistency in the specification code or documentation text.
title: ''
labels: 'bug :beetle:'
assignees: ''

---

<!-- Please do not use this issue type to report a use case or an implementation idea; we have separate issue types for that! -->

**Describe the bug**

(Describe the problem as concisely as possible.)
98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/certification.yml
@@ -0,0 +1,98 @@
name: Platform Certification
description: Jakarta Data Platform Certification
title: "[Certification]: "
labels: ["certification"] #TODO need to add this label
body:
- type: markdown
attributes:
value: >
Before submitting a Platform Certification to the Jakarta Data community
please read and be familiar with the
[TCK Process document](https://jakarta.ee/committees/specification/tckprocess)
which may be updated occasionally.
- type: input
id: organization
validations:
required: true
attributes:
label: Organization
description: Organization name and URL (if applicable)
- type: input
id: implementation
validations:
required: true
attributes:
label: Implementation
description: Product name, version, and download URL (if applicable)
- type: input
id: specification
validations:
required: true
attributes:
label: Specification
description: Specification name, version, and download URL (if applicable)
- type: input
id: tck
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK)
description: TCK name, version, and download URL (if applicable)
- type: input
id: tckSHA
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK) Validation
description: TCK SHA-256 fingerprint
- type: textarea
id: tckResults
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK) Results
description: |
Public URL of TCK Results Summary
TIP: You can attach TCK Results to this issue by clicking this area to highlight it and then dragging files in.
# TODO determine if we wil have any additional certification requirements
# Will users need to test against a NoSQL/SQL database?
- type: textarea
id: additionalRequirements
validations:
required: true
attributes:
label: Additional Specification Requirements
description: >
Specification projects may require additional items for a Certification Request
as defined in their corresponding TCK Documentation under the section labeled "Additional Certification Requirements".
- type: textarea
id: javaRuntime
validations:
required: true
attributes:
label: Java Runtime(s)
description: |
Java runtime(s) used to run the implementation.
Output from `java -version`
- type: textarea
id: environment
validations:
required: true
attributes:
label: Environments
description: Summary of the information for the certification environment, operating system, cloud, etc.
- type: checkboxes
id: ackEFTL
attributes:
label: Eclipse Foundation Technology Compatibility Kit License (EFTL)
description: Do you accept the terms of the (EFTL)?
options:
- label: By checking this box I acknowledge that the organization I represent accepts the terms of the [EFTL](https://www.eclipse.org/legal/tck.php)
required: true
- type: checkboxes
id: ackRules
attributes:
label: TCK Requirements and Compatibility
options:
- label: By checking this box I attest that all TCK requirements have been met, including any compatibility rules.
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/clarification.md
@@ -0,0 +1,14 @@
---
name: Clarification request
about: Request that some aspect of the specification be clarified.
title: ''
labels: 'clarification :mag_right:'
assignees: ''

---

**Description**

<!-- please describe the requested clarification here -->


88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/tck-challenge.yml
@@ -0,0 +1,88 @@
name: TCK Challenge
description: Jakarta Data TCK Challenge
title: "[TCK Challenge]: "
labels: ["challenge"] #TODO need to add this label
body:
- type: markdown
attributes:
value: >
Before submitting a TCK Challenge to the Jakarta Data community
please read and be familiar with the
[TCK Process document](https://jakarta.ee/committees/specification/tckprocess)
which may be updated occasionally.
- type: input
id: specification
validations:
required: true
attributes:
label: Specification
description: What specification is the challenge related to? Provide a link to the specification class or document section.
placeholder: |
ex. [Entity value](https://github.com/jakartaee/data/blob/main/api/src/main/java/jakarta/data/Entity.java#L33)
- type: input
id: assertion
validations:
required: true
attributes:
label: Assertion
description: What assertion is the challenge related to? Provide a link to the assertion description
placeholder: |
ex. [Signature tests](https://github.com/jakartaee/data/blob/main/tck/src/main/java/ee/jakarta/tck/data/standalone/signature/SignatureTests.java#L50)
- type: dropdown
id: version
validations:
required: true
attributes:
label: TCK Version
description: What version of the TCK are you running against?
options: #TODO need to update this list per release
- 1.0.0-SNAPSHOT (Locally built)
- 1.0.0-RC1 (Release candidate)
- 1.0.0 (Generally available)
- type: input
id: implementation
validations:
required: true
attributes:
label: Implementation being tested
description: What implementation is being tested? Include name of company/organization
placeholder: |
ex. Open Liberty / IBM
- type: dropdown
id: challengeType
validations:
required: true
attributes:
label: Challenge Scenario
description: Which of the following scenarios best match this challenge?
options:
- Claims that a test assertion conflicts with the specification.
- Claims that a test asserts requirements over and above that of the specification.
- Claims that an assertion of the specification is not sufficiently implementable.
- Claims that a test is not portable or depends on a particular implementation.
- Something else
- type: textarea
id: fullDescription
validations:
required: true
attributes:
label: Full Description
description: |
Describe the challenge in full detail including logs.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
value: |
> Description of issue using markdown syntax
- type: textarea
id: additionalContext
attributes:
label: Additional Context
description: Additional context about the problem, possible solutions, alternative interpretations, etc.
- type: checkboxes
attributes:
label: Is there an existing challenge for this?
description: |
Please search to see if a challenge already exists, or has been approved, that matches your challenge.
https://github.com/jakartaee/data/issues?q=is%3Aissue+label%3Achallenge
options:
- label: I have searched the existing issues
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/use-case.md
@@ -0,0 +1,25 @@
---
name: Use case
about: Describe a new use case for the specification.
title: ''
labels: 'use case :bulb:'
assignees: ''

---

**Description**

As a:

- [ ] Application user/user of the configuration itself
- [ ] API user (application developer)
- [ ] SPI user (container or runtime developer)
- [ ] Specification implementer

...I need to be able to:

<!-- please provide your use case details here -->

...which enables me to:

<!-- please provide the expected benefit of solving use case here -->

0 comments on commit 1e0c536

Please sign in to comment.