Recent

Author Topic: Bug in bug report template  (Read 1172 times)

Aloysius

  • Newbie
  • Posts: 2
Bug in bug report template
« on: September 30, 2021, 03:43:18 pm »
  Hello,
unsure where else to report this.

When filing a bug on gitlab, I've noticed that if one uses spaces between brackets in the OS field (e.g.
Code: Pascal  [Select][+][-]
  1. <openSUSE Tumbleweed>
), then the field will be empty in the resulting message.

Martin_fr

  • Administrator
  • Hero Member
  • *
  • Posts: 7516
  • Debugger - SynEdit - and more
    • wiki
Re: Bug in bug report template
« Reply #1 on: September 30, 2021, 03:45:43 pm »
The brackets <> are supposed to be removed.

Like in the rest of the template
Code: Pascal  [Select][+][-]
  1. <Please fill in>
You would not write the entire description between <> ?

Aloysius

  • Newbie
  • Posts: 2
Re: Bug in bug report template
« Reply #2 on: September 30, 2021, 04:26:08 pm »
The brackets <> are supposed to be removed.

Like in the rest of the template
Code: Pascal  [Select][+][-]
  1. <Please fill in>
You would not write the entire description between <> ?

That's what I did. Was it wrong?

Martin_fr

  • Administrator
  • Hero Member
  • *
  • Posts: 7516
  • Debugger - SynEdit - and more
    • wiki
Re: Bug in bug report template
« Reply #3 on: September 30, 2021, 05:50:58 pm »
The brackets <> are supposed to be removed.

Like in the rest of the template
Code: Pascal  [Select][+][-]
  1. <Please fill in>
You would not write the entire description between <> ?

That's what I did. Was it wrong?
No its right to remove.

But you said you did replace the
Quote
<__>
with
Code: Pascal  [Select][+][-]
  1. <openSUSE Tumbleweed>
So in this case you did not.

You should be able to edit your issue.



Gitlab allows various <foo> tags to control the content (like <br/> or <b></b>)

So apparently gitlab treats <openSUSE Tumbleweed> as invisible tag. (I guess, I am not a developer in the gitlab team)

Martin_fr

  • Administrator
  • Hero Member
  • *
  • Posts: 7516
  • Debugger - SynEdit - and more
    • wiki
Re: Bug in bug report template
« Reply #4 on: September 30, 2021, 05:59:46 pm »
If this is to misleading, the <> can be taken off the template.

But in the end, whatever you put in there, will be marked up by gitlab. So leading spaces, leading #, ''' and various others all translate into markup.


Also, the template is meant as a guideline, so important bits are not forgotten.

E.g.
Quote
## What happens
<Please fill in>

## What did you expect
<Please fill in>

If you write "foo bar CRASHES", then it is ok to leave the "what did you expect" empty or even remove it.

The reason the section is there, is that it is not always obvious.

Like if you said "bar.foo shows a red square", we might not know what you expect: show nothing, a red circle, a blue square, two red squares ...
You may think it is obvious, but spelling it out can save the extra round of getting feedback.
So it depends on how universally obvious it really is.


In the same sense, if you report that the word "objecd" is misspelled in some comment in the source => well your OS really does not matter. ;)
« Last Edit: September 30, 2021, 06:03:13 pm by Martin_fr »

 

TinyPortal © 2005-2018