Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (33 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.86 KB
Raw

Contributing guidelines

Feature request

Check out the issue tracker for existing feature requests. Create a new issue if it does not already exist.

Finding something to work on

To get started with this project, try working on one of the issues labeled with scope: S, which involve fewer components and are easier to get into without prior familiarity with the codebase.

Issues labeled with k: * require specific domain knowledge not acquired by the average developer.

Code style

  • Before committing, run the following checks:
cargo +nightly fmt -- --check
cargo clippy --all --tests -- -D warnings
cargo test --all
  • Use the structure of foo.rs, foo/submodule.rs, etc. Do not use foo/mod.rs.
  • Do not import bevy::prelude::*, nor to import the re-exports from bevy::prelude if a direct import is possible.
  • Unit tests should be under a separate tests.rs file and included from the parent with #[cfg(test)] mod tests;.
  • Use distance_cmp and magnitude_cmp for comparing vector norms. Do not use the exact or squared methods for comparisons alone.
  • Use Vec::from([...]) or [...].into() instead of vec![...] for Vec literals. Large expressions in macros tend to be unfriendly to rust-analyzer.
    • For consistency, use Vec::new() instead of vec![] for empty Vecs.
  • Use the TryLog extension trait for getting components from World or Query if absence of the component would be a bug. Similarly, use try_log/try_log_return where suitable. The None branch should result in termination of processing of the current entity, unless the system involves aggregation over all queried entities, in which case the aggregation result must not be used to avoid propagating errors.