Skip to content

Commit

Permalink
chore: Add issue and discussion templates (#1193)
Browse files Browse the repository at this point in the history
Adds issue and a discussion template such that developers can use a more structured flow when reporting bugs, asking for features, etc.
  • Loading branch information
orpheuslummis authored Mar 23, 2023
1 parent 56b89d7 commit 4a3c120
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/DISCUSSION_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
title: "[Feature request] "
labels: ["Submit a request for a new feature or improvement."]
body:
- type: textarea
id: problem
attributes:
label: Is the request related to a problem?
description: "Provide a clear and concise description of what the problem is. Ex. I'm frustrated when [...]"
- type: textarea
id: feature
attributes:
label: The feature you would like
description: "Provide a clear and concise description of what you want to happen."
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: "Describe alternatives you've considered"
- type: textarea
id: context
attributes:
label: Additional context
description: "Add any other context or screenshots about the feature request here."
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''
---

**Describe the problem**
(*replace*) A clear and concise description of what the bug is.

**To Reproduce**
(*replace*) Steps to reproduce the behavior.

**Expected behavior**
(*replace*) A clear and concise description of what you expected to happen.

**Platform**
(*replace*) The platform information and DefraDB's version obtained with the `defradb version` command.

**Additional context**
(*replace*) Add any other context about the problem here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Feature request
url: https://github.com/sourcenetwork/defradb/discussions/new?category=feature-request
about: To request a new feature or improvement.
- name: Discussion
url: https://github.com/sourcenetwork/defradb/discussions
about: To discuss DefraDB or ask questions.

0 comments on commit 4a3c120

Please sign in to comment.