Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Develop guidelines for "what goes in the prelude" #8810

Open
alice-i-cecile opened this issue Jun 10, 2023 · 0 comments
Open

Develop guidelines for "what goes in the prelude" #8810

alice-i-cecile opened this issue Jun 10, 2023 · 0 comments
Labels
A-Meta About the project itself C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation C-Usability A simple quality-of-life change that makes Bevy easier to use

Comments

@alice-i-cecile
Copy link
Member 

          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 #8778 (comment)

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
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation C-Code-Quality A section of code that is hard to understand or change C-Usability A simple quality-of-life change that makes Bevy easier to use A-Meta About the project itself labels Jun 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Meta About the project itself C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation C-Usability A simple quality-of-life change that makes Bevy easier to use
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alice-i-cecile