Typedoc: add an issue template

Created on 25 Dec 2018  路  6Comments  路  Source: TypeStrong/typedoc

I see many issues that could possibly be very helpful, but some of them have no proper reproduction (like #925, #911, #904, #893, and more). And it's also a time consuming job to reproduce it ourselves just by reading from the issue or ask each author to reproduce his/her problem.

The best thing to do, I believe, is to make a common issue template so that authors could know before posting that they should reproduce their problems as well in many cases.

Probably an issue template would be some kind of this format:

Expected Behavior

Actual Behavior

Steps to Reproduce the Problem

1.
1.
1.

Specifications

  • Version:
  • Platform:
  • Subsystem:

And the same thing for PR templates & Code of conduct. It would make it easy for people to contribute.

good first issue help wanted

Most helpful comment

I will write one and submit a PR. I think better direction could be making multiple issue templates for bug reports and feature requests.

All 6 comments

馃憤 I agree a issue template would be helpful especially with bug reports.

My request is that it is simple/easy enough to use and understand that we don't trade _issue reports with little information_ for _issue reports with little information sprinkled in a lot of boilerplate_.

@aciccarello I cannot propose (make a PR) on the issue template. Guess it's only restricted to collaborators. Could you propose one instead? My opinion is that a bit of tweaks would work if you would want to make the suggested format above simpler/easier.

Creating the file ISSUE_TEMPLATE.md should let you propose a template according to the GitHub docs

@Gerrit0 Cool! Thanks for pointing that out.

I will write one and submit a PR. I think better direction could be making multiple issue templates for bug reports and feature requests.

Hi,

For the issue #904, I already mentioned the test file and the expected output within the bug. Please help me out with the scenario.

Was this page helpful?
0 / 5 - 0 ratings