Skip to content

Commit

Permalink
docs: update issue template (#224)
Browse files Browse the repository at this point in the history
  • Loading branch information
aalmeida00 authored Nov 24, 2023
1 parent 0416ab6 commit 2202732
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 13 deletions.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
name: Bug report
about: Create a new bug report to help us improve Octopost
title: ''
labels: ''
assignees: ''
---

**Describe the bug**
A short description of what the bug is.

<details open>
<summary>
<b>Description</b>
</summary>
[Describe the bug reported]
</details>

<br>

<details>
<summary>
<b>Steps to Reproduce</b>
</summary>

[If applicable, provide detailed steps to reproduce the bug.]

</details>

<br>

<details>
<summary>
<b>Expected Behavior</b>
</summary>
[Describe what is expected to happen.]
</details>

<br>

<details>
<summary>
<b>Current Behavior</b>
</summary>
[Describe what is currently happening.]
</details>

<br>

<details>
<summary>
<b>Visual information</b>
</summary>
[If possible, add screenshots to illustrate this bug.]
</details>

<br>

<details>
<summary>
<b>Additional Information</b>
</summary>
[Provide any additional information, such as relevant versions, browser, OS, context, etc.]

</details>
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Feature request
about: Suggest a feature to be added to Octopost
title: ''
labels: ''
assignees: ''

---

**Describe the feature**
A clear and short description of the feature.

<details open>
<summary>
<b>Description</b>
</summary>
[Describe the new feature requested.]
</details>

<br>

<details>
<summary>
<b>Use Case</b>
</summary>

[Explain the use for this feature and how it might benefits the project.]
</details>

<br>

<details>
<summary>
<b>Implementation Details</b>
</summary>

[Provide any details or suggestions on how this feature could be implemented.]
</details>

<br>

<details>
<summary>
<b>Visual Concepts</b>
</summary>

[Include any visual representations or concepts if those are available and applicable.]
</details>

<br>

<details>
<summary>
<b>Additional Information</b>
</summary>

[Provide any additional information, such as context that might be relevant to the implementation of this specific feature.]
</details>
23 changes: 10 additions & 13 deletions .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
---
name: Issue
about: Create a new issue to help us improve Octopost
name: Bug report
about: Create a new bug report to help us improve Octopost
title: ''
labels: needs triage
labels: ''
assignees: ''
---

## [Issue Title]

_label: [tag1, tag2]
<br>
assignees: [assignee_username]_
**Describe the bug**
A short description of what the bug is.

<details open>
<summary>
<b>Description</b>
</summary>
[Describe the issue or feature requested]
[Describe the bug reported]
</details>

<br>
Expand All @@ -26,7 +23,7 @@ assignees: [assignee_username]_
<b>Steps to Reproduce</b>
</summary>

[If applicable, provide detailed steps to reproduce the issue.]
[If applicable, provide detailed steps to reproduce the bug.]

</details>

Expand All @@ -36,7 +33,7 @@ assignees: [assignee_username]_
<summary>
<b>Expected Behavior</b>
</summary>
[Describe what you expect to happen.]
[Describe what is expected to happen.]
</details>

<br>
Expand All @@ -54,7 +51,7 @@ assignees: [assignee_username]_
<summary>
<b>Visual information</b>
</summary>
[If possible, add screenshots to illustrate the issue.]
[If possible, add screenshots to illustrate this bug.]
</details>

<br>
Expand All @@ -63,6 +60,6 @@ assignees: [assignee_username]_
<summary>
<b>Additional Information</b>
</summary>
[Provide any additional information, such as relevant versions, context, etc.]
[Provide any additional information, such as relevant versions, browser, OS, context, etc.]

</details>

0 comments on commit 2202732

Please sign in to comment.