-
-
Notifications
You must be signed in to change notification settings - Fork 734
Add issue templates #935
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
Add issue templates #935
Conversation
Avoid documenting excluded files. (TypeStrong#896)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together! Could we make some improvements to the working?
Fix diction Co-Authored-By: 9oelM <[email protected]>
Co-Authored-By: 9oelM <[email protected]>
Co-Authored-By: 9oelM <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating. A few more minor changes before we enable this.
Co-Authored-By: 9oelM <[email protected]>
Thanks for putting this together! |
Rationale
Currently, Typedoc does not have issue templates, so I have raised an issue on that (#928)
Many people are graciously giving contributions, but sometimes it's hard to understand their intentions or problems. Therefore it seems it's a better approach to make an issue template.
Templates
CONTRIBUTING.md
.Goal
I tried to lead contributors to the right direction but did not want to annoy them with a bunch of lines of comments. Plus, as @aciccarello said, I wanted to keep it as simple as possible for the risk of submissions of issues with almost no information hidden under an already-well-written template of length.