bevyengine / bevyengine/bevy

Develop guidelines for "what goes in the prelude"

Open
#8,810 0 comments 7 reactions 0 assignees View on GitHub
A-Meta C-Code-Quality C-Docs C-Usability
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

Hmm. I really wish we had clear guidelines on "what goes in the prelude". My personal take is that this is rarely used (once per app generally), and should not be added to the prelude.

_Originally posted by @alice-i-cecile in https://github.com/bevyengine/bevy/issues/8778#issuecomment-1584823561_

Right now, contributors have difficulty deciding and agreeing on what items belong in the prelude. We should figure out a set of guidelines, then add it to CONTRIBUTING.md.

Some initial thoughts:

- extremely commonly used
- traits whose methods end users will call regularly (hi bevy_ecs extensions)
- names that are likely to clash with other common imports or user defined code are bad

Contributor guide

Open the contributing guide

Research direction

Start by reading CONTRIBUTING.md and the prelude-related discussion linked from this issue. Turn the stated considerations into clear guidelines for contributors, including the initial thoughts about common use, regularly called traits, and name clashes. Done means the agreed guidance is added to CONTRIBUTING.md.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.