Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
Note about maximum line width of code listings added to issue templates
  • Loading branch information
simpleinjector committed Mar 28, 2019
1 parent 802d7bd commit 2451bf7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Expand Up @@ -25,6 +25,7 @@ Add any other context about the problem here. e.g.:
* .NET version * .NET version
*Used libraries or frameworks (with version) that are required *Used libraries or frameworks (with version) that are required


**Tip** **Important**
* Do *not* include screen shots of [code](https://idownvotedbecau.se/imageofcode) or [exceptions](https://idownvotedbecau.se/imageofanexception/). * Do *not* include screen shots of [code](https://idownvotedbecau.se/imageofcode) or [exceptions](https://idownvotedbecau.se/imageofanexception/).
* Do ensure that code listing don't have a line width that exceeds 100 characters, as that would cause horizontal scrollbars, which make it harder to view the code.
* Follow the guidelines given by Stack Overflow and [IDownvotedBecau.se](https://idownvotedbecau.se/). * Follow the guidelines given by Stack Overflow and [IDownvotedBecau.se](https://idownvotedbecau.se/).
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/question-and-feature-request.md
Expand Up @@ -14,6 +14,7 @@ Describe your problem, question, or feature in a clear and concise way. Please m
* Show a **simplified, but realistic, representation of your application**. We are not interested to see a large amount of source code, but DI-related questions are typically design questions and it is impossible to feedback on your design when you reduce your interfaces and classes to e.g. `IFoo`, `Flux` and `Baz`. * Show a **simplified, but realistic, representation of your application**. We are not interested to see a large amount of source code, but DI-related questions are typically design questions and it is impossible to feedback on your design when you reduce your interfaces and classes to e.g. `IFoo`, `Flux` and `Baz`.
* Include **complete stack trace including all exception details** of the exception and all inner exceptions in case an exception is thrown. * Include **complete stack trace including all exception details** of the exception and all inner exceptions in case an exception is thrown.
* Do **not include screen shots** of [code](https://idownvotedbecau.se/imageofcode), but provide actual code * Do **not include screen shots** of [code](https://idownvotedbecau.se/imageofcode), but provide actual code
* Do ensure that code listing don't have a **line width that exceeds 100 characters**, as that would cause horizontal scrollbars, which make it harder to view the code.
* Do not include screen shots of [exceptions](https://idownvotedbecau.se/imageofanexception/), but paste the actual exception details * Do not include screen shots of [exceptions](https://idownvotedbecau.se/imageofanexception/), but paste the actual exception details
* Make sure that code and exception details are [formatted correctly](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) and ideally include the programming language (typically `c#`). This way GitHub will highlight the code automatically. * Make sure that code and exception details are [formatted correctly](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) and ideally include the programming language (typically `c#`). This way GitHub will highlight the code automatically.
* Follow the guidelines given by Stack Overflow and [IDownvotedBecau.se](https://idownvotedbecau.se/) about asking good questions. * Follow the guidelines given by Stack Overflow and [IDownvotedBecau.se](https://idownvotedbecau.se/) about asking good questions.
Expand Down

0 comments on commit 2451bf7

Please sign in to comment.