-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update templates to use html comments (#106)
These comments won't show up in the final markdown, allowing us to put the verbose wording in them and keep the actual content light
- Loading branch information
Showing
2 changed files
with
19 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,11 @@ | ||
Thanks for using AutoDispose. Before you create an issue, please consider the following points: | ||
<!-- | ||
Thanks for using AutoDispose. Before you create an issue, please consider the following points to help us best diagnose the issue. | ||
Feel free to remove any irrelevant parts that you know are not related to the issue. | ||
Any HTML comment like this will be stripped when rendering markdown, no need to delete them. | ||
--> | ||
|
||
- [ ] If you think you found a bug, please include a code sample that reproduces the problem. A stacktrace alone is ok too, but may not contain enough context for us to deduce the issue from. | ||
<!-- Please include the library version number, including the minor and patch version (like `1.0.0`), in the issue text. --> | ||
**Library version**: | ||
|
||
- [ ] Please include the library version number, including the minor and patch version, in the issue text. | ||
<!-- If you think you found a bug, please include a code sample that reproduces the problem. A stacktrace alone is ok too, but may not contain enough context for us to deduce the issue from. --> | ||
**Repro steps or stacktrace**: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,13 @@ | ||
Thank you for contributing to AutoDispose. Before pressing the "Create Pull Request" button, please consider the following points: | ||
<!-- | ||
Thank you for contributing to AutoDispose. Before pressing the "Create Pull Request" button, please consider the following points. | ||
Feel free to remove any irrelevant parts that you know are not related to the issue. | ||
Any HTML comment like this will be stripped when rendering markdown, no need to delete them. | ||
--> | ||
|
||
- [ ] Please give a description about what and why you are contributing, even if it's trivial. | ||
<!-- Please give a description about what and why you are contributing, even if it's trivial. --> | ||
**Description**: | ||
|
||
- [ ] Please include the issue list number(s) or other PR numbers in the description if you are contributing in response to those. | ||
<!-- Please include the issue list number(s) or other PR numbers in the description if you are contributing in response to those. --> | ||
**Related issue(s)**: | ||
|
||
- [ ] Please include a reasonable set of unit tests if you contribute new code or change an existing one. | ||
<!-- Please include a reasonable set of unit tests if you contribute new code or change an existing one. --> |