bevyengine / bevyengine/bevy

Relationship ordering behavior is not documented nor tested

Open
#20,546 1 comment 0 reactions 0 assignees View on GitHub
A-ECS A-UI C-Docs C-Testing D-Straightforward S-Ready-For-Implementation X-Uncontroversial
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

## How can Bevy's documentation be improved?
The ordering in which relationships are ordered is not currently documented anywhere, and is behavior we're going to be relying on for UI consistency.

A cursory check through our tests also shows we're missing unit tests to ensure this behavior does not change as well.

Contributor guide

Open the contributing guide

Research direction

Start by locating Bevy's relationship-ordering implementation and the existing relationship tests. Confirm the current ordering behavior, document it for users relying on UI consistency, and add unit coverage that fails if the behavior changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.