Skip to content

Commit 6a0a030

Browse files
committed
Clarify MSRV policy
1 parent e0668e2 commit 6a0a030

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,22 @@ Pull requests are likely to be subjected to constructive and careful reviewing,
2525
and it may take some time before they are accepted and merged.
2626
Please do not be discouraged to contribute when not facing the expected outcome,
2727
or feeling that your work or proposal goes unheard.
28-
The project is maintained by volunteers outside of work hours.
28+
The project is primarily maintained by volunteers outside of work hours.
2929

3030
[GitHub issue tracker]: https://github.com/Enet4/dicom-rs/issues
3131

3232
### Building the project
33-
As a pure Rust ecosystem,
33+
34+
The DICOM-rs ecosystem is built on Rust ecosystem.
35+
it may use bindings for integration with other non-Rust libraries
36+
providing additional capabilities, such as more image encodings,
37+
but in this case they are automatically fetched and built
38+
during the standard building process.
39+
3440
Cargo is the main tool for building all crates in DICOM-rs.
3541
[Rustup] is the recommended way to set up a development environment
3642
for working with Rust.
37-
DICOM-rs expects the latest stable toolchain.
43+
See also the current [Minimum Supported Rust Version (MSRV) policy][msrv].
3844

3945
Currently, all crates are gathered in the same workspace,
4046
which means that running the command below
@@ -68,8 +74,10 @@ cargo fmt
6874
```
6975

7076
[Rustup]: https://rustup.rs
77+
[msrv]: README.md#Minimum-Supported-Rust-version
7178

7279
## Discussion and roadmapping
80+
7381
If you have more long-termed ideas about what DICOM-rs should include next,
7482
please have a look at the [roadmap] and look into existing issues to provide feedback.
7583
You can also talk about the project at the official [DICOM-rs Zulip organization][zulip].
@@ -82,4 +90,5 @@ please reach out to the project maintainers.
8290
[zulip]: https://dicom-rs.zulipchat.com
8391

8492
## Project team and governance
93+
8594
DICOM-rs is currently led by Eduardo Pinho ([**@Enet4**](https://github.com/Enet4), <enet4mikeenet@gmail.com>).

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,17 @@ no other development dependencies are necessary
101101
unless certain extensions are included via Cargo features.
102102
Consult each crate for guidelines on selecting features to suit your needs.
103103

104-
Minimum supported Rust version is 1.72.0 and only applies to the library crates with default features.
105-
Binary crates and extra features may require a newer version of Rust.
104+
### Minimum Supported Rust version
105+
106+
DICOM-rs currently provides partial MSRV guarantees,
107+
defined by the following rules:
108+
109+
- The minimum supported Rust version required to build _library crates_ with default features is **1.72.0**.
110+
- For any other cases, namely building the tool/binary crates or including extra features,
111+
only the latest stable toolchain is guaranteed to build.
112+
113+
At of 2025-10-04, version 1.80.0 can build the full project,
114+
though this is not prescriptive and is subject to change over time.
106115

107116
## Roadmap & Contributing
108117

0 commit comments

Comments
 (0)