mirror of
https://github.com/krille-chan/fluffychat
synced 2024-09-10 09:05:10 +00:00
docs: Better issue templates and adding config.yml
This commit is contained in:
krille-chan
parent
7c3eff67bc
commit
310eff393d
3 changed files with 152 additions and 55 deletions
106
.github/ISSUE_TEMPLATE/bug_report.md
vendored
106
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,30 +1,76 @@
|
||||||
---
|
name: 🐛 Bug report
|
||||||
name: Bug report
|
description: Create a report to help us improve
|
||||||
about: Create a report to help us improve
|
labels: ["Bug"]
|
||||||
labels: Bug
|
body:
|
||||||
---
|
- type: markdown
|
||||||
|
attributes:
|
||||||
### Describe the bug
|
value: "## Describe the bug"
|
||||||
<!-- A clear and concise description of what the bug is. -->
|
- type: textarea
|
||||||
|
id: bug-description
|
||||||
### To Reproduce
|
attributes:
|
||||||
<!-- Steps to reproduce the behavior: -->
|
label: "Bug Description"
|
||||||
<!-- 1. Go to '...' -->
|
description: "A clear and concise description of what the bug is."
|
||||||
<!-- 2. Click on '....' -->
|
placeholder: "Describe the bug here..."
|
||||||
<!-- 3. Scroll down to '....' -->
|
validations:
|
||||||
<!-- 4. See error -->
|
required: true
|
||||||
|
- type: markdown
|
||||||
### Expected behavior
|
attributes:
|
||||||
<!-- A clear and concise description of what you expected to happen. -->
|
value: "## To Reproduce"
|
||||||
|
- type: textarea
|
||||||
### Screenshots
|
id: reproduce-steps
|
||||||
<!-- If applicable, add screenshots to help explain your problem. -->
|
attributes:
|
||||||
|
label: "Steps to Reproduce"
|
||||||
### Platform (please complete the following information):
|
description: "Steps to reproduce the behavior:"
|
||||||
<!-- - App Version [e.g. 1.12.0] -->
|
placeholder: "1. Go to '...'\n2. Click on '...'\n3. Scroll down to '...'\n4. See error"
|
||||||
<!-- - Device: [e.g. iPhone6, PC, Pixel 3] -->
|
validations:
|
||||||
<!-- - OS: [e.g. iOS, Android, Windows, Linux, macOS] -->
|
required: true
|
||||||
<!-- - Browser (if applicable): [e.g. Chrome, Safari] -->
|
- type: markdown
|
||||||
|
attributes:
|
||||||
### Additional context
|
value: "## Expected behavior"
|
||||||
<!-- Add any other context about the problem here. -->
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: "Expected Behavior"
|
||||||
|
description: "A clear and concise description of what you expected to happen."
|
||||||
|
placeholder: "Describe what you expected to happen here..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Screenshots"
|
||||||
|
- type: input
|
||||||
|
id: screenshots
|
||||||
|
attributes:
|
||||||
|
label: "Screenshots"
|
||||||
|
description: "If applicable, add screenshots to help explain your problem."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Platform"
|
||||||
|
- type: input
|
||||||
|
id: app-version
|
||||||
|
attributes:
|
||||||
|
label: "App Version"
|
||||||
|
description: "Please provide the version of the app you are using."
|
||||||
|
placeholder: "e.g. 1.12.0"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: platform-info
|
||||||
|
attributes:
|
||||||
|
label: "Additional Platform Information"
|
||||||
|
description: "Please provide the following information:"
|
||||||
|
placeholder: "Device: [e.g. iPhone6, PC, Pixel 3]\nOS: [e.g. iOS, Android, Windows, Linux, macOS]\nBrowser (if applicable): [e.g. Chrome, Safari]"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Additional context"
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: "Additional Context"
|
||||||
|
description: "Add any other context about the problem here."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
|
||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: FluffyChat Community
|
||||||
|
url: https://matrix.to/#/#fluffychat:matrix.org
|
||||||
|
about: Please ask and answer questions here.
|
||||||
|
- name: Report security vulnerabilities
|
||||||
|
url: https://matrix.to/#/@krille:janian.de
|
||||||
|
about: Please report security vulnerabilities here.
|
||||||
93
.github/ISSUE_TEMPLATE/feature_request.md
vendored
93
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,25 +1,68 @@
|
||||||
---
|
name: 💡 Feature Request
|
||||||
name: Feature Request
|
description: Suggest an idea for this project
|
||||||
about: Suggest an idea for this project
|
labels: ["Enhancement"]
|
||||||
labels: Enhancement
|
body:
|
||||||
---
|
- type: markdown
|
||||||
|
attributes:
|
||||||
### Feature Description
|
value: "## Feature Description"
|
||||||
<!-- Provide a clear and concise description of the feature. -->
|
- type: textarea
|
||||||
|
id: feature-description
|
||||||
### Rationale
|
attributes:
|
||||||
<!-- Explain why this feature should be added. -->
|
label: "Feature Description"
|
||||||
|
description: "Provide a clear and concise description of the feature."
|
||||||
### Functionality
|
placeholder: "Describe the feature here..."
|
||||||
<!-- Describe what the feature would do and how it should work. -->
|
validations:
|
||||||
|
required: true
|
||||||
### Mockup
|
- type: markdown
|
||||||
<!-- If applicable, add any visual mock-ups of the feature. -->
|
attributes:
|
||||||
|
value: "## Rationale"
|
||||||
### Platform (please complete the following information if applicable):
|
- type: textarea
|
||||||
<!-- - OS: [e.g. iOS, Android, Windows, Linux, macOS] -->
|
id: rationale
|
||||||
<!-- - Browser [e.g. Chrome, Safari] -->
|
attributes:
|
||||||
<!-- - Version [e.g. 22] -->
|
label: "Rationale"
|
||||||
|
description: "Explain why this feature should be added."
|
||||||
### Additional context
|
placeholder: "Describe the rationale for the feature here..."
|
||||||
<!-- Add any other context or screenshots about the feature request here. -->
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Functionality"
|
||||||
|
- type: textarea
|
||||||
|
id: functionality
|
||||||
|
attributes:
|
||||||
|
label: "Functionality"
|
||||||
|
description: "Describe what the feature would do and how it should work."
|
||||||
|
placeholder: "Describe the functionality of the feature here..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Mockup"
|
||||||
|
- type: input
|
||||||
|
id: mockup
|
||||||
|
attributes:
|
||||||
|
label: "Mockup"
|
||||||
|
description: "If applicable, add any visual mock-ups of the feature."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Platform"
|
||||||
|
- type: input
|
||||||
|
id: platform-info
|
||||||
|
attributes:
|
||||||
|
label: "Platform Information"
|
||||||
|
description: "Please provide the following information if applicable:"
|
||||||
|
placeholder: "OS: [e.g. iOS, Android, Windows, Linux, macOS]\nBrowser [e.g. Chrome, Safari]\nVersion [e.g. 22]"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Additional context"
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: "Additional Context"
|
||||||
|
description: "Add any other context or screenshots about the feature request here."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue