Skip to content

Commit

Permalink
docs(ISSUE_TEMPLATE): use ## h2 headers, newline before long URLs (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
dupuy committed Mar 21, 2024
1 parent 52ef686 commit 4f6e77a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 11 deletions.
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,26 @@ assignees: ''
---

> Before suggesting an enhancement, search for similar issues:
> \
> https://github.com/dupuy/reliabot/issues?q=is%3Aissue+sort%3Acomments-desc
> If you find one, please add a comment in that issue. For more help, see
> \
> https://github.com/dupuy/reliabot/blob/main/CONTRIBUTING.md##suggesting-enhancements.
**Is this enhancement related to a problem? Please describe.**
## _If the enhancement is:_ Related to a problem

_Explain the problem you're having, such as "it's frustrating when …" and how
this enhancement would help._

**Describe the solution you want to see.**
## Describe the solution you want to see

_Explain how you want Reliabot to work, providing as many details as possible._

**Outline alternatives you've considered**
## Outline alternatives you've considered

_Summarize any alternatives, and explain why they aren't as good._

**Provide a rationale.**
## Provide a rationale

_Explain why this enhancement would be useful to many reliabot users._
15 changes: 9 additions & 6 deletions .github/ISSUE_TEMPLATE/problem.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,22 @@ assignees: ''
---

> Before reporting a problem, search for similar issues:
> \
> https://github.com/dupuy/reliabot/issues?q=is%3Aissue+sort%3Acomments-desc
> If you find one, please add a comment in that issue. For more help, see
> https://github.com/dupuy/reliabot/blob/main/CONTRIBUTING.md##reporting-problems.
> \
> https://github.com/dupuy/reliabot/blob/main/CONTRIBUTING.md#reporting-problems.
> ⚠️**Don't report security related issues or vulnerabilities here**. See
> https://github.com/dupuy/reliabot/security/policy for security report steps.
> \
> https://github.com/dupuy/reliabot/security/policy for secure reporting.
**Describe the problem**
## Describe the problem

_Briefly describe the expected behavior and Reliabot's actual behavior._

**How you can reproduce the problem**
## How you can reproduce the problem

_Outline the steps to show the problem you are having._

Expand All @@ -32,11 +35,11 @@ _Outline the steps to show the problem you are having._

4. _Link to a public GitHub repository or provide `tree` or `ls -R` output._

**Screenshots**
## Screenshots

_If applicable, add screenshots to help explain your problem._

**Context**
## Context

_Add any other context about the problem here._

Expand Down
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ assignees: ''
---

> Before asking a question, search for similar issues:
> \
> https://github.com/dupuy/reliabot/issues?q=is%3Aissue+sort%3Acomments-desc
> If you find one, but still need help, ask your question in that issue. A few
> internet search queries may turn up an answer. For help asking questions, see
> internet searches may turn up an answer. For help asking questions, see
> \
> https://github.com/dupuy/reliabot/blob/main/CONTRIBUTING.md#asking-a-question.
_Provide as much context as you can for your question._
Expand Down

0 comments on commit 4f6e77a

Please sign in to comment.