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

Invalid tester response example #1299

Open
3 tasks
NorbertLoh opened this issue Jan 20, 2025 · 1 comment
Open
3 tasks

Invalid tester response example #1299

NorbertLoh opened this issue Jan 20, 2025 · 1 comment

Comments

@NorbertLoh
Copy link
Contributor

NorbertLoh commented Jan 20, 2025

Describe the bug
Examples for tester response seems to be incorrect example in user workflow, example in code comments and testing

To Reproduce
Steps to reproduce the behavior:

  1. Go to an issue with a 'team's response'
  2. Copy example found in user workflow
  3. Issue will be under 'Faulty Issues' in CATcher

Expected behavior
Issue should move to 'Issues Pending Response'

Screenshots

Image

Desktop (please complete the following information):

  • OS: Windows 11
  • Browser Chrome
  • Version 131.0.6778.86

Additional context
From further investigation. The issue comes from Team chose [type.DocumentationBug]. and **Reason for disagreement:**.

  1. The parser expects ``Team chose [type.DocumentationBug]` how in the example an additional `.` is supplied.
  2. The parser expects **Reason for disagreement:** as seen in tester response section parser. However, when directly copied, the additional whitespace at the end is removed.

Possible solutions

  1. Remove the . at the end of the issue descriptions
  2. Preserving the white space could be similar to Consecutive spaces inside back-ticks show as single space #1273

Performing the above 2 possible solutions produces the expected results.

Image

Below is the updated example (note whitespace is not copied).

# Team's Response

Description of team's response
# Items for the Tester to Verify
## :question: Issue response

Team chose [`response.Rejected`]

- [ ] I disagree

**Reason for disagreement:**
[replace this with your reason]

<catcher-end-of-segment><hr>
## :question: Issue severity

Team chose [`severity.Low`]

Originally [`severity.High`]

- [ ] I disagree

**Reason for disagreement:** 
[replace this with your reason]

<catcher-end-of-segment><hr>
## :question: Issue type

Team chose [`type.DocumentationBug`].

Originally [`type.FunctionalityBug`].

- [ ] I disagree

**Reason for disagreement:**
[replace this with your reason]

<catcher-end-of-segment><hr>

Steps to resolving

  • Fix example in user workflow documentation
  • Fix example in code comments
  • Fix example in testing documentation
@Arif-Khalid
Copy link
Contributor

Arif-Khalid commented Jan 26, 2025

Thanks Norbert for pointing out the issue. I experience the issue as well.
I have added the discrete steps in check-boxes at the bottom of the issue description so that it is more clear which parts are still pending.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants