Katex: Add issue templates

Created on 7 Jul 2018  路  6Comments  路  Source: KaTeX/KaTeX

Most helpful comment

Is there a way to bypass the template?

If multiple issue templates exist, template selection page will be shown with open a regular issue button to bypass them:

All 6 comments

I think this is a great idea. Can we only have a single issue template? I vaguely remember seeing a repo one time that allowed you to pick from a couple of different templates when submitting an issue.

@kevinbarabash Originally GitHub supported only one issue template, a markdown(.md) file at issue_template.md or .github/issue_template.md. Now, as you said, it is possible to create multiple issue templates by using template builder or putting multiple files in .github/ISSUE_TEMPLATE/

Cool. What do people think about having two issue templates: one for bug reports and one for feature requests? We also have "discussion" issues from time to time. Is there a way to bypass the template? If not maybe we should also have a "discussion" template.

Some suggestions for what to include in the bug-report template, off the top of my head:

  • KaTeX version (with some basic instructions about how to measure katex.version -- I wonder if we should also add a \katex@version macro that can be used within KaTeX?).
  • Web framework they're using (either that they're developing in, or an existing website).
  • A pointer to common issues in the README that they should check first.

For feature requests, I'd suggest an explicit request for how you'd achieve the requested effect in regular LaTeX, if that's possible.

Is there a way to bypass the template?

If multiple issue templates exist, template selection page will be shown with open a regular issue button to bypass them:

Cool!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mbourne picture mbourne  路  3Comments

janosh picture janosh  路  4Comments

fabiospampinato picture fabiospampinato  路  4Comments

pvnr0082t picture pvnr0082t  路  4Comments

asmeurer picture asmeurer  路  3Comments