Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create tck_challenge.md #217

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/tck_challenge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: TCK Challenge
about: Create a TCK Challenge
title: ''
labels: 'challenge'
assignees: ''

---

Copy link
Contributor

@tomjenkinson tomjenkinson Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should prompt people to review https://jakarta.ee/committees/specification/tckprocess/ as part of the process.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand what you meant. It is not my aim to prompt people to review the process. If you want to achieve that, please feel free to propose a PR.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone came here to raise a challenge, they might have visited the tck process.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is important that the challenge is filed by an appropriate person: https://jakarta.ee/committees/specification/tckprocess/#_who_can_file_a_challenge - is there someway that during raising the challenge information can be provided so it can be verified an implementor is raising the issue?

I think you should also provide space for the other parts of the requirements when filing a challenge:
https://jakarta.ee/committees/specification/tckprocess/#_filing_a_challenge. I think most of this fits nicely in your format but perhaps the following should have their own sections?:

  • The relevant specification version and section number(s)
  • The implementation being tested, including name and company (maybe this is the first part of this comment?)

**Challenged tests**
List the challenged tests with the fully qualified classnames and then the test methods, e.g.
ee.jakarta.tck.wombat.MyTest#testSomething

**TCK Version**
Specify the version of the TCK, e.g. Jakarta Transactions 2.x
tomjenkinson marked this conversation as resolved.
Show resolved Hide resolved
Emily-Jiang marked this conversation as resolved.
Show resolved Hide resolved

**Description**
A clear and concise description of why you think the tests are wrong.

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