Skip to content

Commit

Permalink
Add new issue template that helps users creating TCK challenges
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Marlow <smarlow@redhat.com>
  • Loading branch information
scottmarlow committed Dec 17, 2020
1 parent c40a006 commit f1a8412
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/tck_challenge.md
@@ -0,0 +1,30 @@
---
name: Platform TCK Challenge
about: Create TCK challenges in the appropriate SPEC project
title: 'Challenges for tests written specifically for Platform SPEC requirements belong here'
labels: 'challenge'
assignees: ''

---

**Follow the TCK Process document**
Please follow the instructions in the TCK Process document (https://jakarta.ee/committees/specification/tckprocess) which may be updated occasionally.

**Filing a Challenge**

TCK Challenges MUST be filed via the specification project’s issue tracker using the label challenge and include the following information:

1. The relevant specification version and section number(s).
2. The coordinates of the challenged test(s).
3. The exact TCK version.
4. The implementation being tested, including name and company.
5. A full description of why the test is invalid and what the correct behavior is believed to be.
6. Any supporting material; debug logs, test output (.jtr file), test logs, run scripts, etc.

For an example of an existing TCK challenge, see https://github.com/eclipse-ee4j/servlet-api/issues/378

**Additional context**
Add any other context about the problem here.

** Note that the source for this page is contained in https://github.com/eclipse-ee4j/jakartaee-tck/tree/master/.github/ISSUE_TEMPLATE, pull requests are welcome to improve!
I'm also sharing this link so other projects see how they can specify an ISSUE_TEMPLATE for new issues. :-)

0 comments on commit f1a8412

Please sign in to comment.