summaryrefslogtreecommitdiff
path: root/vendor/rustix/CONTRIBUTING.md
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-07-02 18:36:06 -0600
committermo khan <mo@mokhan.ca>2025-07-02 18:36:06 -0600
commit8cdfa445d6629ffef4cb84967ff7017654045bc2 (patch)
tree22f0b0907c024c78d26a731e2e1f5219407d8102 /vendor/rustix/CONTRIBUTING.md
parent4351c74c7c5f97156bc94d3a8549b9940ac80e3f (diff)
chore: add vendor directory
Diffstat (limited to 'vendor/rustix/CONTRIBUTING.md')
-rw-r--r--vendor/rustix/CONTRIBUTING.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/vendor/rustix/CONTRIBUTING.md b/vendor/rustix/CONTRIBUTING.md
new file mode 100644
index 00000000..8e9a64fc
--- /dev/null
+++ b/vendor/rustix/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Contributing to rustix
+
+Rustix is a [Bytecode Alliance] project. It follows the Bytecode Alliance's
+[Code of Conduct] and [Organizational Code of Conduct].
+
+## Testing
+
+To keep compile times low, most features in rustix's API are behind cargo
+features. A special feature, `all-apis` enables all APIs, which is useful
+for testing.
+
+```console
+cargo test --features=all-apis
+```
+
+And, rustix has two backends, linux_raw and libc, and only one is used in
+any given build. To test on Linux with the libc backend explicitly,
+additionally enable the `use-libc` feature:
+
+```console
+cargo test --features=all-apis,use-libc
+```
+
+Beyond that, rustix's CI tests many targets and configurations. Asking for
+help is always welcome, and it's especially encouraged when the issue is
+getting all the `cfg`s lined up to get everything compiling on all the
+configurations on CI.