Skip to content

Commit

Permalink
Update issue-template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jutanium authored Jul 3, 2022
1 parent 98165bc commit 25a83d0
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions .github/ISSUE_TEMPLATE/issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,17 @@ assignees: ''

---

A good issue contains
A good issue _descriptive_ and _explanatory_: it describes precisely what should change and why that change should happen.

- A description of the problem (or new content/feature). If you can, include where the problem is in the repository.
- An explanation as to why this is a problem, or why this content/feature should be added. Ideally, explain _who_ is affected by this.
- A suggestion of a path forward, if you have one in mind!
- If suggesting a new content page, make sure to explain which [content type](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md#content-types) the page should be.
**For reporting bugs and problems with content, include:**

- A description of the problem
- A link to the page that has the problem
- An explanation as to why this is a problem. Ideally, explain _who_ is affected by this.
- If you're reporting a problem with content, refer to our [writing guide](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md) for our baseline content standards.
- A suggestion of a fix, if you have one in mind!


**For suggesting new content**:
- If you're suggesting an addition to an existing page, explain what is missing and why this is a problem.
- If you're suggesting a new content page, make sure to explain which [content type](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md#content-types) the page should be.

0 comments on commit 25a83d0

Please sign in to comment.