Skip to content

Commit

Permalink
chore: update github form templates
Browse files Browse the repository at this point in the history
  • Loading branch information
crazy-max committed May 5, 2023
1 parent ceb87f2 commit 4b27f27
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 33 deletions.
67 changes: 34 additions & 33 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,95 +1,96 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
name: Bug Report
description: Report a bug
labels:
- status/triage

body:

- type: checkboxes
attributes:
label: Contributing guidelines
description: Please read the contributing guidelines before proceeding.
label: Support guidelines
description: Please read the support guidelines before proceeding.
options:
- label: I've read the [contributing guidelines](https://github.com/crazy-max/ftpgrab/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree
- label: I've read the [support guidelines](https://github.com/crazy-max/ftpgrab/blob/master/.github/SUPPORT.md)
required: true

- type: checkboxes
attributes:
label: I've found a bug and checked that ...
description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
description: |
Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
options:
- label: ... the documentation does not mention anything about my problem
- label: ... there are no open or closed issues that are related to my problem

- type: textarea
attributes:
label: Description
description: Please provide a brief description of the bug in 1-2 sentences.
description: |
Please provide a brief description of the bug in 1-2 sentences.
validations:
required: true

- type: textarea
attributes:
label: Expected behaviour
description: Please describe precisely what you'd expect to happen.
description: |
Please describe precisely what you'd expect to happen.
validations:
required: true

- type: textarea
attributes:
label: Actual behaviour
description: Please describe precisely what is actually happening.
description: |
Please describe precisely what is actually happening.
validations:
required: true

- type: textarea
attributes:
label: Steps to reproduce
description: Please describe the steps to reproduce the bug.
description: |
Please describe the steps to reproduce the bug.
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true

- type: textarea
- type: input
attributes:
label: Version
description: Please provide FTPGrab, operating system version and system infirmation.
value: |
* FTPGrab version (5.0.0):
* Platform (windows/linux/freebsd/macos):
* System info (type `uname -a`):
* Remote FTP (Pure-FTPd) or SFTP (OpenSSH) server:
label: FTPGrab version
validations:
required: true

- type: textarea
attributes:
label: Configuration
description: Please provide a minimal (!) [`ftpgrab.yml` config](https://crazymax.dev/ftpgrab/config/) to reproduce the bug.
placeholder: |
server:
ftp:
host: test.rebex.net
port: 21
username: demo
password: password
sources:
- /
download:
output: /download
render: yaml
label: Docker info
description: |
Output of `docker info` command.
render: text
validations:
required: true

- type: textarea
attributes:
label: Docker Compose config
description: |
Output of `docker compose config` command (if applicable).
render: yaml

- type: textarea
attributes:
label: Logs
description: Please provide FTPGrab logs (set `--log-level debug` and `--log-ftp`).
description: |
Please provide the container logs (set log-level to debug and enable log-caller).
render: text
validations:
required: true

- type: textarea
attributes:
label: Additional info
description: Please provide additional information.
description: |
Please provide any additional information that seem useful.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: Questions and Discussions
url: https://github.com/crazy-max/ftpgrab/discussions/new
about: Use Github Discussions to ask questions and/or open discussion topics.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
name: Feature request
description: Missing functionality? Come tell us about it!
labels:
- kind/enhancement
- status/triage

body:
- type: textarea
id: description
attributes:
label: Description
description: What is the feature you want to see?
validations:
required: true

0 comments on commit 4b27f27

Please sign in to comment.