Skip to content

Commit

Permalink
Contributing.md and readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ReCore-sys committed Dec 1, 2024
1 parent 06d2db5 commit 11dee0e
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 12 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,26 @@ If you add a new directory, please add it to the above list along with its purpo
19. If your code isn't sufficiently documented, you will be asked to add documentation.
20. If your code doesn't have tests where it should, you will be asked to add tests.

## Notes on formatting

Some IDEs have an automatic formatter that will format the code when you save. It is recommended to use this feature to
keep the code formatted correctly.
<br> If you are using VSCode, you can use the `rust-analyzer` extension to format the
code
automatically. This [StackOverflow answer](https://stackoverflow.com/a/67861602/15894829) explains how to set this
up.<br>
If you are using a JetBrains IDE (Intellij, RustRover, CLion, etc.), you can use the `Rust` plugin to format the code
automatically (This plugin is not required for RustRover).
This [Docs page](https://www.jetbrains.com/help/idea/reformat-and-rearrange-code.html#reformat-on-save)
explains how to set this up. Clippy formatting on the fly is recommended as well, though this can cause a noticeable
performance hit.

Automatic formatting is highly recommended as it will ensure that the code you write is correctly formatted as you go,
instead of running `cargo clippy` when you are done and having 400 clippy errors to fix at once. You should still run
the clippy and fmt commands before submitting a PR to make sure that the code is correctly formatted and passes the
lints,
but automatic formatting will help to catch most of these issues as you go.

## Code of Conduct

Please note we have a code of conduct, please follow it in all your interactions with the project.
Expand Down
22 changes: 11 additions & 11 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ debug-assertions = false
overflow-checks = false
panic = "abort"

[profile.hyper]
inherits = "release"
lto = true
opt-level = 3
debug = false
debug-assertions = false
overflow-checks = false
panic = "abort"
codegen-units = 1

#=============== Dependencies ==============#
[workspace.dependencies]
# Workspace members
Expand Down Expand Up @@ -108,15 +118,13 @@ log = "0.4.22"
# Concurrency/Parallelism
parking_lot = "0.12.3"
rayon = "1.10.0"
crossbeam = "0.8.4"

# Network

# Error handling
thiserror = "2.0.3"

# Cryptography
rsa = "0.9.6"
rand = "0.9.0-beta.0"
fnv = "1.0.7"

Expand Down Expand Up @@ -174,12 +182,4 @@ memmap2 = "0.9.5"
# Benchmarking
criterion = { version = "0.5.1", features = ["html_reports"] }

[profile.hyper]
inherits = "release"
lto = true
opt-level = 3
debug = false
debug-assertions = false
overflow-checks = false
panic = "abort"
codegen-units = 1

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ programming language, it is completely multithreaded and offers high performance
</li>
<li>
<h4>🗂️ Customizable configuration</h4>
<img src="https://github.com/ferrumc-rs/ferrumc/assets/README/config.png?raw=true" alt="Configuration">
<img src="https://github.com/ferrumc-rs/ferrumc/assets/README/config.toml.png?raw=true" alt="Configuration">
</li>
<li>
<h4>🔄 Can import existing worlds from vanilla minecraft</h4>
Expand Down
Binary file added assets/README/config.toml.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 11dee0e

Please sign in to comment.