Skip to content

Commit

Permalink
Add Issue Templates
Browse files Browse the repository at this point in the history
Add Bug Report Template
Add Feature Request Template
  • Loading branch information
MrRowey committed Jun 17, 2024
1 parent d74b18e commit ef7ecd9
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug reporting
description: A template you can use to report bugs and/or unexpected behavior.
title: '[Bug]: '
labels: ['Bug']

body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug! This template will help you with creating a report that we can use to understand the bug.
- This repository is maintained by volunteers, it may take a while for them to come back to you.
- Remember to include sufficent details and context.
- If you have mutiple questions, suggestions, or bugs, please submit them in seperate issuses.
- We accept pull requets. If you know how to fix it - go ahead!
Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.*
- type: markdown
attributes:
value: |
Provide a clear & concise description of the bug.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the observed behavior
placeholder: Tell us what you see!
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: How do you reproduce this? Please provide as much step-by-step detail as possible.
value: |
1.
2.
3.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: What did you expect to happen when the reproduce steps are followed?
placeholder: Tell us what you expected to see!
validations:
required: true

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature request
description: Create a feature request to discuss with the Game team
title: "[Feature]: "
labels: ["Enhancement"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time in making a Feature Request.
- This repository is maintained by volunteers, it may take a while for them to come back to you.
- Remember to include sufficient details and context.
- If you have multiple Idea's or suggestions, please submit them in separate issues.
- We accept pull request. If you know how to fix it - go ahead!
- type: textarea
id: describe
attributes:
label: Describe the Feature
description: A clear and concise description of what the feature is.
validations:
required: true
- type: textarea
id: behavior
attributes:
label: Expected Behavior
description: If applicable, a clear and concise description of what you expect to happen in various scenario's.
validations:
required: true
- type: textarea
id: images
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your feature.
validations:
required: false
- type: textarea
id: Additional
attributes:
label: Additional context
description: Add any other context about the feature here.
validations:
required: false
- type: markdown
attributes:
value: |
_This feature request will be read by people that are unable to look into your thoughts - this request is all they have to determine the viability of the feature. The more precise your request, the easier it becomes for us to help you._
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: FAForever Discord Server
url: https://discord.gg/GEseYDXVRA
about: Discuss the game, report bugs, and get help with modding and development!
- name: FAForever Forums
url: https://forum.faforever.com/
about: Discuss the game and learn about the latest tournaments or news in the community!
- name: Looking for contributors
url: https://discord.gg/Rnpv8RwhdU
about: There's so much to do - we're always looking for contributors to help out with the project!

0 comments on commit ef7ecd9

Please sign in to comment.