From 2b4fa60e97fea0877b170dc0d3dfc0d376427d35 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Mon, 2 May 2022 09:17:01 -0400 Subject: [PATCH 1/2] Clean up advice on glob imports in style guide --- .github/contributing/engine_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/contributing/engine_style_guide.md b/.github/contributing/engine_style_guide.md index b19ad9120f5b5..2dd27fbe51cb5 100644 --- a/.github/contributing/engine_style_guide.md +++ b/.github/contributing/engine_style_guide.md @@ -6,7 +6,7 @@ For more advice on contributing to the engine, see the [relevant section](../../ ## General guidelines -1. Prefer granular imports over glob imports of `bevy::prelude::*` and `bevy::sub_crate::*`. +1. Prefer granular imports over glob imports like `bevy::ecs::prelude::*`. 2. Use a consistent comment style: 1. `///` doc comments belong above `#[derive(Trait)]` invocations. 2. `//` comments should generally go above the line in question, rather than in-line. From b1732d9e6e10e76285419fa9270ae9c024bde355 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Mon, 2 May 2022 10:15:15 -0400 Subject: [PATCH 2/2] Update .github/contributing/engine_style_guide.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: François --- .github/contributing/engine_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/contributing/engine_style_guide.md b/.github/contributing/engine_style_guide.md index 2dd27fbe51cb5..36b3781bd97dc 100644 --- a/.github/contributing/engine_style_guide.md +++ b/.github/contributing/engine_style_guide.md @@ -6,7 +6,7 @@ For more advice on contributing to the engine, see the [relevant section](../../ ## General guidelines -1. Prefer granular imports over glob imports like `bevy::ecs::prelude::*`. +1. Prefer granular imports over glob imports like `bevy_ecs::prelude::*`. 2. Use a consistent comment style: 1. `///` doc comments belong above `#[derive(Trait)]` invocations. 2. `//` comments should generally go above the line in question, rather than in-line.