1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Contributing
Contributions are welcome. This project models planets across all star systems, so physical correctness is critical.
## Getting Started
```bash
git clone https://github.com/celestial4498-prog/PlanetsFactory.git
cd PlanetsFactory
cargo build
cargo test --all-targets
```
## Before Submitting
1. **Tests pass** — `cargo test --all-targets`
2. **No warnings** — `cargo clippy --all-targets`
3. **Formatted** — `cargo fmt`
4. **Examples run** — all three examples exit with code 0
## Guidelines
- Keep physics accurate. Cite sources for new formulas or constants.
- No `println!`/`eprintln!` to suppress unused values — consume them through real computation.
- Match existing code style. No doc-comments on internals.
- New planet types go in `src/types/` with corresponding tests in `tests/types_tests.rs`.
- New physics modules need integration tests in `tests/`.
- New preset systems go in `src/presets/` with `all()` aggregator functions.
- Use `sciforge` for physical constants — don't hardcode them.
- Edition 2024, dependencies use `"*"`.
## Adding a New Planet Type
1. Create `src/types/your_type.rs` with a struct and preset constructors
2. Add class-specific methods and physical properties
3. Register in `src/types/mod.rs`
4. Add tests in `tests/types_tests.rs`
5. Optionally add presets in `src/presets/`
## Reporting Issues
Open an issue with:
- What you expected vs what happened
- Minimal reproduction steps
- Relevant test output
## License
By contributing, you agree that your contributions are licensed under MIT.
## Contact
Join the Discord server: https://discord.com/channels/1489158007219556487/1489181752923656212