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

Feedback on CATcher formatting #93

Open
Deculsion opened this issue Nov 9, 2019 · 1 comment
Open

Feedback on CATcher formatting #93

Deculsion opened this issue Nov 9, 2019 · 1 comment
Labels

Comments

@Deculsion
Copy link

Currently the input box when creating a new bug does not appear to follow the github markdown, Thus, when doing a preview of the bug description in catcher, it is not what it will actually look like in Github.

In our case, our UG uses <angular brackets> to specify parameters. In github markdown, these characters have to be escaped or it will be be treated as HTML tags stuff. However, Catcher's preview function does not require these characters to be escaped. Thus, many of our bug reports which reference our command syntax does not showup properly as the tester did not escape these characters.

For example in this issue: AY1920S1-CS2113T-F09-3/main#310
The angular brackets had to be escaped by us manually to be able to view the text properly. The original has all the text within angular brackets not appearing.

@Deculsion Deculsion changed the title Feedback on Catcher formatting Feedback on CATcher formatting Nov 9, 2019
@cyanoei
Copy link

cyanoei commented Nov 9, 2019

Since this issue will probably persist in the actual PE, everyone should generally take note of this when writing up issues to submit, since it could possibly affect the ability of the developer team (and markers) to understand the bug report.

Our team nearly closed the issue mentioned above because without the additional params the tester's command would have been wrong.

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

No branches or pull requests

3 participants