Skip to content

Commit

Permalink
feat: added discussion templates
Browse files Browse the repository at this point in the history
  • Loading branch information
brendanfalk committed Nov 11, 2022
1 parent 1408ff4 commit cd8c2e5
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/DISCUSSION_TEMPLATE/1_main_issue_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: "Issue Template"
description: "File an issue related to Fig"
title: "bug: "
labels: ["NEED_TO_LABEL", "type:bug"]

body:
- type: checkboxes
id: "checks"
attributes:
label: "Checks"
options:
- label: "I have searched [github.com/withfig/fig/issues](https://github.com/withfig/fig/issues?q=) and there are no duplicates of my issue"
required: true
- label: "I have run `fig doctor` in the affected terminal session"
required: true
- label: "I have run `fig restart` and replicated the issue again"
required: true

- type: input
id: "os"
attributes:
label: "Operating system"
validations:
required: true

- type: textarea
id: "expected"
attributes:
label: "Expected behaviour"
description: "What did you expect to happen?"
validations:
required: true

- type: textarea
id: "actual"
attributes:
label: "Actual behaviour"
description: "What actually happened? Please provide a screenshot or video if possible."
validations:
required: true

- type: textarea
id: "reproduce"
attributes:
label: "Steps to reproduce"
description: "Are you able to reproduce this issue? If so, how?"

- type: textarea
id: "environment"
attributes:
label: "Environment"
description: "If possible, run `fig diagnostic` and paste the output below."
render: yaml
18 changes: 18 additions & 0 deletions .github/DISCUSSION_TEMPLATE/2_feature_request_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: New Feature Template
description: All new feature requests except ones relating to specific CLI tools
labels: [NEED_TO_LABEL]
body:
- type: checkboxes
attributes:
label: Sanity checks
options:
- label: "I have searched [github.com/withfig/fig/issues](https://github.com/withfig/fig/issues?q=) and there are no duplicates of my feature"
required: true
- type: textarea
attributes:
label: Feature Details
description: What should this feature do? What problem does it solve?
# Because we are using hashtags at the start of a line, we must put the value in quotes. We cannot use YAML's multiline syntax with the pipe symbol
value: "### Description:\n> Please include a detailed description of the feature (and an image or screen recording, if applicable)"
validations:
required: true
15 changes: 15 additions & 0 deletions .github/DISCUSSION_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
blank_issues_enabled: true
contact_links:
- about: "e.g. git, kubectl, npm etc"
name: My issue relates to a specific CLI tool
url: "https://github.com/withfig/autocomplete/issues/new/choose"
- about: "Find detailed guides about common support issues in our forum"
name: "💬 GitHub Discussions"
url: "https://github.com/withfig/fig/discussions"
- about: "Get instant support from the Fig Community Discord"
name: "👋 Discord"
url: "https://fig.io/community"
- about: "Get support from the Fig team at [email protected]"
name: "📩 Email"
url: "https://tinyurl.com/y4m9zqlw"

0 comments on commit cd8c2e5

Please sign in to comment.