Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/.github/ISSUE_TEMPLATE/bug_report.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
---
name: Bug Report
about: Report a bug to help us improve!
title: ''
new labels: bug report
2021-07-13 20:28:05 +00:00
labels: C-Bug, S-Needs-Triage
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
assignees: ''
---
Cleanup of Markdown Files and add CI Checking (#1463) I have run the VSCode Extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) on all Markdown Files in the Repo. The provided Rules are documented here: https://github.com/DavidAnson/markdownlint/blob/v0.23.1/doc/Rules.md Rules I didn't follow/fix: * MD024/no-duplicate-heading * Changelog: Here Heading will always repeat. * Examples Readme: Platform-specific documentation should be symmetrical. * MD025/single-title * MD026/no-trailing-punctuation * Caused by the ! in "Hello, World!". * MD033/no-inline-html * The plugins_guidlines file does need HTML, so the shown badges aren't downscaled too much. * ~~MD036/no-emphasis-as-heading:~~ * ~~This Warning only Appears in the Github Issue Templates and can be ignored.~~ * ~~MD041/first-line-heading~~ * ~~Only appears in the Readme for the AlienCake example Assets, which is unimportant.~~ --- I also sorted the Examples in the Readme and Cargo.toml in this order/Priority: * Topic/Folder * Introductionary Examples * Alphabetical Order The explanation for each case, where it isn't Alphabetical : * Diagnostics * log_diagnostics: The usage of inbuild Diagnostics is more important than creating your own. * ECS (Entity Component System) * ecs_guide: The guide should be read, before diving into other Features. * Reflection * reflection: Basic Explanation should be read, before more advanced Topics. * WASM Examples * hello_wasm: It's "Hello, World!".
2021-02-22 04:50:05 +00:00
## Bevy version
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Regularized Issue Templates so that the grammar is always the same. (#787) * Regularized Issue Templates so that the grammar is always the same. * Update bug_report.md Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2020-11-05 00:38:05 +00:00
The release number or commit hash of the version you're using.
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
## \[Optional\] Relevant system information
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
If you cannot get Bevy to build or run on your machine, please include:
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
- the Rust version you're using (you can get this by running `cargo --version`)
- Bevy relies on the "latest stable release" of Rust
- nightly should generally work, but there are sometimes regressions: please let us know!
- the operating system or browser used, including its version
- e.g. Windows 10, Ubuntu 18.04, iOS 14
If your bug is rendering-related, copy the adapter info that appears when you run Bevy.
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
```ignore
`AdapterInfo { name: "NVIDIA GeForce RTX 2070", vendor: 4318, device: 7938, device_type: DiscreteGpu, backend: Vulkan }`
```
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
You should also consider testing the examples of our upstream dependencies to help isolate any setup-specific issue:
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
- [`wgpu`](https://github.com/gfx-rs/wgpu) for rendering problems
- [`winit`](https://github.com/rust-windowing/winit) for input and window management
- [`gilrs`](https://docs.rs/gilrs/latest/gilrs/) for gamepad inputs
## What you did
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
Describe how you arrived at the problem. If you can, consider providing a code snippet or link.
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
## What went wrong
If it's not clear, break this out into:
- what were you expecting?
- what actually happened?
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Cleanup of Markdown Files and add CI Checking (#1463) I have run the VSCode Extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) on all Markdown Files in the Repo. The provided Rules are documented here: https://github.com/DavidAnson/markdownlint/blob/v0.23.1/doc/Rules.md Rules I didn't follow/fix: * MD024/no-duplicate-heading * Changelog: Here Heading will always repeat. * Examples Readme: Platform-specific documentation should be symmetrical. * MD025/single-title * MD026/no-trailing-punctuation * Caused by the ! in "Hello, World!". * MD033/no-inline-html * The plugins_guidlines file does need HTML, so the shown badges aren't downscaled too much. * ~~MD036/no-emphasis-as-heading:~~ * ~~This Warning only Appears in the Github Issue Templates and can be ignored.~~ * ~~MD041/first-line-heading~~ * ~~Only appears in the Readme for the AlienCake example Assets, which is unimportant.~~ --- I also sorted the Examples in the Readme and Cargo.toml in this order/Priority: * Topic/Folder * Introductionary Examples * Alphabetical Order The explanation for each case, where it isn't Alphabetical : * Diagnostics * log_diagnostics: The usage of inbuild Diagnostics is more important than creating your own. * ECS (Entity Component System) * ecs_guide: The guide should be read, before diving into other Features. * Reflection * reflection: Basic Explanation should be read, before more advanced Topics. * WASM Examples * hello_wasm: It's "Hello, World!".
2021-02-22 04:50:05 +00:00
## Additional information
Add issue and pull request templates (#551)
2020-10-15 20:47:23 +00:00
Make bug template more beginner-friendly (#4652) # Objective 1. "What you expected to happen" and "what actually happened" often involves trivial duplication. 2. "Please provide full reproduction steps" is not helpful advice to new contributors. 3. The OS field was commonly useless or inadequate. 4. The description for "additional information" effectively just repeated the title of the field. ## Solution 1. Unify these fields into a single "what went wrong" field. 2. Provide an example of a useful reproduction. 3. Replace OS field with an optional "Setup Information" field that captures information about other critical setup like Rust version and hardware. 4. Provide helpful advice about what sort of information may be useful to add.
2022-05-30 22:11:44 +00:00
Other information that can be used to further reproduce or isolate the problem.
This commonly includes:
- screenshots
- logs
- theories about what might be going wrong
- workarounds that you used
- links to related bugs, PRs or discussions
Reference in a new issue Copy permalink