search

bundestag / gesetze-tools

Scripts to maintain German law git repository
GNU Lesser General Public License v3.0
114 stars 21 forks source link

Improve issue templates. #42

Closed darkdragon-001 closed 3 years ago

darkdragon-001 commented 3 years ago

🍰 Pullrequest

I modified the copied templates to be more suitable for this repository.

Issues

ulfgebhardt commented 3 years ago

I do not understand why you intentionally break the markdown syntax?! 👀 Also why do you remove the comments and make it visible text? That makes no sense to me either

darkdragon-001 commented 3 years ago

I do not understand why you intentionally break the markdown syntax?! 👀

Can you give me an example? My markdown highlighting doesn't show me any problems...

Also why do you remove the comments and make it visible text? That makes no sense to me either

Such that people are forced to replace these instructions instead of ignoring them. Furthermore, especially for the question issue for people not familiar with Markdown, they might add their actual text inside the comment and could be wondering why their text isn't shown in the output. Plus, it's shorter.

ulfgebhardt commented 3 years ago

I mean you use the bold feature instead of headings. That's what I mean with breaking the syntax. I will approve this - if you think its worthwhile.

darkdragon-001 commented 3 years ago

I mean you use the bold feature instead of headings. That's what I mean with breaking the syntax.

I inspected some other repos and the majority seems to prefer bold over headline. If you prefer headlines, I can use them as well. It's just that I don't like to use headlines for formatting when one doesn't use the whole hierarchy (e.g. no top-level headlines # since they appear too big for issues).

If you prefer headlines, tell me and I will convert it.

if you think its worthwhile

The important changes are removal of issue types which don't fit in my opinion, addition of issue types which I think are missing and improving the sections and examples in the remaining issue types. I don't care about the formatting too much, it was just my examples preferring this way and I liked it more. I am totally fine with different formatting though.

Tell me when all problems are resolved for you such that I can click the merge button then.

ulfgebhardt commented 3 years ago

Don't worry about it - go ahead with the changes - its just issue templates, nothing to have an argument about ;)