bevy/.github/ISSUE_TEMPLATE/bug_report.md at 891f6a1f487603b09993a97cbbfadfb424253841

mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00

MinerSebas c9f19d8663 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

646 B

Raw Blame History

name	about	title	labels	assignees
Bug Report	Report a bug to help us improve!

Bevy version

The release number or commit hash of the version you're using.

Operating system & version

Ex: Windows 10, Ubuntu 18.04, iOS 14.

What you did

The steps you took to uncover this bug. Please list full reproduction steps if feasible.

What you expected to happen

What you think should've happened if everything was working properly.

What actually happened

The actual result of the actions you described.

Additional information

Any additional information you would like to add such as screenshots, logs, etc.

646 B Raw Blame History