mirror of
https://github.com/SFML/SFML.git
synced 2024-11-28 22:31:09 +08:00
Add new versions of the issue templates
This commit is contained in:
Lukas Dürrenberger
Chris Thrasher
parent
326ccf8f81
commit
7d0fa3c3fa
53
.github/ISSUE_TEMPLATE.md
vendored
53
.github/ISSUE_TEMPLATE.md
vendored
@ -1,53 +0,0 @@
|
|||||||
Thanks for raising your issue here! 🙂
|
|
||||||
|
|
||||||
Before you submit the issue however, we'd like you to consider the follow points.
|
|
||||||
|
|
||||||
* We like to use the issue tracker for confirmed issues.
|
|
||||||
* If you're stuck with SFML, please use [the forum](https://en.sfml-dev.org/forums/index.php#c3) to get help.
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
## Subject of the issue
|
|
||||||
|
|
||||||
Describe your issue here.
|
|
||||||
|
|
||||||
## Your environment
|
|
||||||
|
|
||||||
* Your OS / distro / window manager used
|
|
||||||
* Your version of SFML (2.5.0, git master, etc)
|
|
||||||
* Your compiler and compiler version used
|
|
||||||
* Special compiler flags used
|
|
||||||
|
|
||||||
## Steps to reproduce
|
|
||||||
|
|
||||||
Tell us how to reproduce this issue. Please provide a [minimal, complete and verifiable example](https://stackoverflow.com/help/mcve), you can use the follow template as a start:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#include <SFML/Graphics.hpp>
|
|
||||||
|
|
||||||
int main()
|
|
||||||
{
|
|
||||||
sf::RenderWindow window(sf::VideoMode({1280, 720}), "Minimal, complete and verifiable example");
|
|
||||||
window.setFramerateLimit(60);
|
|
||||||
|
|
||||||
while (window.isOpen())
|
|
||||||
{
|
|
||||||
for (sf::Event event; window.pollEvent(event);)
|
|
||||||
{
|
|
||||||
if (event.type == sf::Event::Closed)
|
|
||||||
window.close();
|
|
||||||
}
|
|
||||||
|
|
||||||
window.clear();
|
|
||||||
window.display();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Expected behavior
|
|
||||||
|
|
||||||
Tell us what should happen
|
|
||||||
|
|
||||||
## Actual behavior
|
|
||||||
|
|
||||||
Tell us what happens instead
|
|
||||||
88
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
88
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,88 @@
|
|||||||
|
name: "Bug report"
|
||||||
|
description: Report a Bug for SFML
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for raising your issue here and taking the time to fill out this bug report! 🙂
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Prerequisite Checklist
|
||||||
|
description: "Before you submit the issue, we'd like you to consider the follow points."
|
||||||
|
options:
|
||||||
|
- label: "I searched for [existing issues](https://github.com/search?q=repo%3ASFML%2FSFML&type=issues) to prevent duplicates"
|
||||||
|
required: true
|
||||||
|
- label: "I searched for [existing discussions on the forum](https://www.google.com/search?q=site%3Ahttps%3A%2F%2Fen.sfml-dev.org) to prevent duplicates"
|
||||||
|
required: true
|
||||||
|
- label: "I am here to report an issue and not to just ask a question or look for help (use the [forum](https://en.sfml-dev.org/forums/index.php#c3) or [Discord](https://discord.gg/nr4X7Fh) instead)"
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe your issue here
|
||||||
|
description: A clear and concise description of what the issue is.
|
||||||
|
placeholder: "Tell us what you see! And don't forget to add error message in full"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: Your Environment
|
||||||
|
description: Please provide some information about your environment
|
||||||
|
value: |
|
||||||
|
- OS / distro / window manager:
|
||||||
|
- SFML version:
|
||||||
|
- Compiler / toolchain:
|
||||||
|
- Special compiler / CMake flags:
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: repro-bug
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Tell us how to reproduce this issue and provide a [minimal, complete and verifiable example](https://stackoverflow.com/help/mcve), you can use the template below
|
||||||
|
value: |
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include <SFML/Graphics.hpp>
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
sf::RenderWindow window(sf::VideoMode({1280, 720}), "Minimal, complete and verifiable example");
|
||||||
|
window.setFramerateLimit(60);
|
||||||
|
|
||||||
|
while (window.isOpen())
|
||||||
|
{
|
||||||
|
for (sf::Event event; window.pollEvent(event);)
|
||||||
|
{
|
||||||
|
if (event.type == sf::Event::Closed)
|
||||||
|
window.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
window.clear();
|
||||||
|
window.display();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: Tell us what should happen
|
||||||
|
placeholder: The circle should be green
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: actual-behavior
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: Tell us what happens instead
|
||||||
|
placeholder: The circle is red
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
17
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
17
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Ask a Question
|
||||||
|
url: https://en.sfml-dev.org/forums/index.php#c3
|
||||||
|
about: Please use the forum to ask questions
|
||||||
|
- name: Chat with the Community
|
||||||
|
url: https://discord.gg/nr4X7Fh
|
||||||
|
about: Join Discord to chat about your problems and ideas
|
||||||
|
- name: Report an issue with the Website or Tutorials
|
||||||
|
url: https://github.com/SFML/SFML-Website/issues/new
|
||||||
|
about: Use the dedicated issue tracker for the SFML Website
|
||||||
|
- name: Report a bug or request a feature for CSFML
|
||||||
|
url: https://github.com/SFML/CSFML/issues/new
|
||||||
|
about: Use the dedicated CSFML issue tracker
|
||||||
|
- name: Report a bug or request a feature for SFML.Net
|
||||||
|
url: https://github.com/SFML/CSFML/issues/new
|
||||||
|
about: Use the dedicated SFML.Net issue tracker
|
||||||
69
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
69
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
name: "Request a Feature"
|
||||||
|
description: Request a change for SFML
|
||||||
|
labels: ["feature"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for bringing up this idea for discussion! 🙂
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Prerequisite Checklist
|
||||||
|
description: "Before you submit the issue, we'd like you to consider the follow points."
|
||||||
|
options:
|
||||||
|
- label: "I searched for [existing issues](https://github.com/search?q=repo%3ASFML%2FSFML&type=issues) to prevent duplicates"
|
||||||
|
required: true
|
||||||
|
- label: "I searched for [existing discussions on the forum](https://www.google.com/search?q=site%3Ahttps%3A%2F%2Fen.sfml-dev.org) to prevent duplicates"
|
||||||
|
required: true
|
||||||
|
- label: "I understand [SFML's scope](https://www.sfml-dev.org/contribute.php#general-considerations) and believe the feature fits it"
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe your feature request here
|
||||||
|
description: A clear and concise description of the wanted change.
|
||||||
|
placeholder: "Tell us what you see! And don't forget to add error message in full"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: use-cases
|
||||||
|
attributes:
|
||||||
|
label: Use Cases
|
||||||
|
description: Explain at least two concrete use cases for this feature.
|
||||||
|
placeholder: |
|
||||||
|
When writing collision detections...
|
||||||
|
|
||||||
|
For the correct positioning of the audio source...
|
||||||
|
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: example
|
||||||
|
attributes:
|
||||||
|
label: API Example
|
||||||
|
description: Please provide an example how the new API could be used
|
||||||
|
value: |
|
||||||
|
```cpp
|
||||||
|
#include <SFML/Graphics.hpp>
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
sf::RenderWindow window(sf::VideoMode({1280, 720}), "Minimal, complete and verifiable example");
|
||||||
|
window.setFramerateLimit(60);
|
||||||
|
|
||||||
|
while (window.isOpen())
|
||||||
|
{
|
||||||
|
for (sf::Event event; window.pollEvent(event);)
|
||||||
|
{
|
||||||
|
if (event.type == sf::Event::Closed)
|
||||||
|
window.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
window.clear();
|
||||||
|
window.display();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
Loading…
Reference in New Issue
Block a user