chore: Add CONTRIBUTING.md #438

Merged
wetneb merged 4 commits from contributing into main 2025-07-03 18:15:25 +02:00
Owner

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 :)
chore: Add CONTRIBUTING.md
All checks were successful
/ test (pull_request) Successful in 58s
7fc25f2ff8
Link to CONTRIBUTING.md from README.md
All checks were successful
/ test (pull_request) Successful in 1m4s
04adb5a01a
Owner

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^^

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^^
Document the testing helpers
All checks were successful
/ test (pull_request) Successful in 1m54s
139370e0fc
CONTRIBUTING.md Outdated
@ -0,0 +5,4 @@
### Code style
To format your code, run `cargo fmt`.
Owner

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
Author
Owner

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.

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.
Owner

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
wetneb force-pushed contributing from 0599f90717 to 8aa384d409 2025-07-03 18:07:09 +02:00 Compare
ada4a approved these changes 2025-07-03 18:14:33 +02:00
wetneb merged commit 4e86fd6978 into main 2025-07-03 18:15:25 +02:00
wetneb referenced this pull request from a commit 2025-07-03 18:15:27 +02:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: mergiraf/mergiraf#438
No description provided.