Add a tip about using RustRover

matrix-org · Aug 20, 2024 · a36fc0c · a36fc0c
1 parent 651b614
commit a36fc0c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.img/rustrover-disable-feature.png b/.img/rustrover-disable-feature.png
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -132,3 +132,13 @@ on Git 2.17+ you can mass signoff using rebase:
 ```
 git rebase --signoff origin/main
 ```
+
+## Tips for working on the `matrix-rust-sdk` with specific IDEs
+
+* [RustRover](https://www.jetbrains.com/rust/) will attempt to sync the project
+  with all features enabled, causing an error in `matrix-sdk` ("only one of the
+  features 'native-tls' or 'rustls-tls' can be enabled"). To work around this,
+  open `crates/matrix-sdk/Cargo.toml` in RustRover and uncheck one of the
+  `native-tls` or `rustls-tls` feature definitions:
+
+  ![Screenshot of RustRover](.img/rustrover-disable-feature.png)