chore: Add CONTRIBUTING.md #438

wetneb · 2025-06-17T17:24:57+02:00

wetneb commented

2025-06-17 17:24:57 +02:00

It's generally a good practice to have such a file, so let's have one :)
I'm not sure what is worth documenting as I have the impression we follow a fairly standard Rust project structure. Feel free to add things directly with further commits on this branch :)

It's generally a good practice to have such a file, so let's have one :) I'm not sure what is worth documenting as I have the impression we follow a fairly standard Rust project structure. Feel free to add things directly with further commits on this branch :)

wetneb added 1 commit

2025-06-17 17:24:58 +02:00

chore: Add CONTRIBUTING.md

/ test (pull_request) Successful in 58s

Details

7fc25f2ff8

wetneb added 1 commit

2025-06-17 20:22:30 +02:00

Link to CONTRIBUTING.md from README.md

/ test (pull_request) Successful in 1m4s

Details

04adb5a01a

ada4a commented

2025-06-18 11:31:39 +02:00

Maybe add something about the helper scripts? I've yet to to use them myself, and that's at least partially because it seemed like a bit of an effort to understand what they're for^^

👍 1

wetneb added 1 commit

2025-06-25 13:17:36 +02:00

Document the testing helpers

/ test (pull_request) Successful in 1m54s

Details

139370e0fc

ada4a reviewed

2025-06-29 17:07:16 +02:00

CONTRIBUTING.md Outdated

					
				@ -0,0 +5,4 @@

				### Code style

				To format your code, run `cargo fmt`.

ada4a commented

2025-06-29 17:07:16 +02:00

This sentence feels a bit lonesome, but I mean we do just use the regular Rust toolset, so it feels a bit redundant to add "lint using cargo clippy, test using cargo test, build using cargo build". OTOH it might be useful for people not familiar with Rust

This sentence feels a bit lonesome, but I mean we do just use the regular Rust toolset, so it feels a bit redundant to add "lint using `cargo clippy`, test using `cargo test`, build using `cargo build`". OTOH it might be useful for people not familiar with Rust

wetneb commented

2025-07-03 14:35:06 +02:00

Let's delete it for now, people not familiar with Rust are probably mostly people adding support for new languages, and if rustfmt complains on their PRs, it should be easy enough to figure it out for them from the CI logs.

ada4a commented

2025-07-03 18:14:24 +02:00

Now that we barely mention the standard cargo commands (only cargo test is left), it reads like we use nothing but these shell script helpers, which is not quite representative... But I don't know how much this matters in practice – again, the Rust toolset is uniquely standardized, so we can expect contributors to be aware of all the commands already

Now that we barely mention the standard cargo commands (only `cargo test` is left), it reads like we use nothing but these shell script helpers, which is not quite representative... But I don't know how much this matters in practice – again, the Rust toolset is uniquely standardized, so we can expect contributors to be aware of all the commands already