Skip to content

Commit

Permalink
templates
Browse files Browse the repository at this point in the history
  • Loading branch information
joaniefromtheblock committed Jan 18, 2024
1 parent c899d49 commit 01c10de
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Site Bug
description: Report a bug in docs
title: '[BUG]: '
labels: ['bug']
body:
- type: markdown
attributes:
value: Thanks for taking the time to submit this issue. Your input is really appreciated.
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
placeholder: Tell us what you see!
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: What actually happened?
placeholder: Tell us what you wanted to see!
- type: textarea
id: steps
attributes:
label: Steps
description: Steps to reproduce the problem
placeholder: 1. Add step.
- type: textarea
id: resolution
attributes:
label: Suggested resolution
description: Do you have thoughts on how this should be addressed?
placeholder: Leave blank if this does not apply.
- type: textarea
id: information
attributes:
label: Additional information
description: Add any other context about the problem here.
placeholder: Leave this section blank if it does not apply.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Consensys
url: https://consensys.io/academy/bootcamp
about: Learn more about Consensys
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/fix-content.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Fix Content
description: Report typos or minor documentation issues
title: '[FIX]: '
labels: ['update']
body:
- type: markdown
attributes:
value: Thanks for taking the time to submit this issue. Your input is appreciated.
- type: textarea
id: issue-location
attributes:
label: Where is the issue?
description: Link to the documentation page(s) where you identified this issue.
placeholder:
- type: textarea
id: issue-text
attributes:
label: What's in the docs?
description: Provide the text or content currently in the docs.
placeholder:
validations:
required: true
- type: textarea
id: text-resolution
attributes:
label: What should be in the docs?
description: Provide a suggested resolution if available.
placeholder:
- type: textarea
id: information
attributes:
label: Additional information
description: Add any other context about the problem here.
placeholder: Leave this section blank if it does not apply.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: New Content
description: For new features or content suggestions
title: '[NEW]: '
labels: ['new content']
body:
- type: markdown
attributes:
value: Thanks for taking the time to submit this issue. Your input is really appreciated.
- type: dropdown
id: issue-priority
attributes:
label: Priority
description: Choose one of the options
options:
- Low
- Medium
- High
validations:
required: true
- type: textarea
id: issue-description
attributes:
label: Description
description: Outline what needs to be changed.
placeholder:
validations:
required: true
- type: textarea
id: issue-impact
attributes:
label: How will this impact users?
description: Outline how this document change will affect users.
placeholder:
validations:
required: true
- type: textarea
id: issue-context
attributes:
label: Context
description: Provide any applicable background information.
placeholder:
validations:
required: true
- type: textarea
id: resolution
attributes:
label: Suggested resolution
description: Do you have thoughts on how this should be addressed?
placeholder: Leave this section blank if this does not apply or you have nothing to add.
- type: textarea
id: information
attributes:
label: Additional information
description: Add any other context about the problem here.
placeholder: Leave blank if this does not apply or you have nothing to add.

0 comments on commit 01c10de

Please sign in to comment.