Skip to content

Remove the safety and contributing sections from the README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tanglearncode merged 1 commit into from
Sep 13, 2026
Merged

Remove the safety and contributing sections from the README #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 0 additions & 38 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,36 +523,6 @@ and [`tests/io.rs`](tests/io.rs). Imported OS and C runtime calls are covered by
[`tests/async_network.rs`](tests/async_network.rs) and
[`tests/http_client.rs`](tests/http_client.rs).

## Safety and limits

The public API checks signatures and keeps unsafe operations inside the library.
You do not need an `unsafe` block, but you must follow these rules to avoid memory
errors. No thread may call a target during its first code patch. Global patches
also need calls stopped during restoration, including drop. The session lock
coordinates sessions, not function calls.

Source and replacement must match in calling convention, argument and return
layout, and lifetimes for every caller. Keep global replacements loaded until they
are restored and locally patched functions loaded until the process exits.
Do not mock memory allocation, locking, or the OS functions shimforge itself uses.
On macOS, use a normal test executable without Hardened Runtime; shimforge does
not change signing settings, entitlements, or system security settings.
Lifetime checks catch common mistakes in ordinary Rust functions. Generic
instances, nested borrowed types, pre-cast pointers, and unsafe or native
functions still need manual lifetime checks.

The test profile above reduces inlining and other optimizations without source
changes. It cannot undo calls already inlined into prebuilt libraries or functions
the linker merged. Short entries and unsupported instruction forms are rejected.
Only the supplied entry point is patched; import jumps are not followed.
`replace!` accepts only noncapturing closures and cannot swap different `async fn`
future types. Use `mock!` for captured closures and `mock_async` for native futures.

Memory permissions are restored after each write. A memory error from `restore()`
keeps the failed patch so you can retry. An expectation error is returned after the
mocks have been removed. A failed rollback or a failed code restoration during drop
aborts the process.

## Licensing

shimforge is source-available under either of two licenses, at your option. You
Expand All @@ -577,11 +547,3 @@ info@xtsoftwarelabs.com.
Neither license is approved by the Open Source Initiative. If your dependency
policy allows only OSI licenses, treat shimforge as commercial software and ask
for a license rather than assuming it is blocked.

## Contributing

Run `./scripts/verify.ps1` on Windows or `bash scripts/verify.sh` on Linux or macOS.
The checks require rustfmt, clippy, llvm-tools-preview, and cargo-llvm-cov 0.8.7.
Use `./scripts/validate-docker.ps1` to run Linux checks in Docker.
All platforms require 100% line and function coverage of library code. Tests and
dependencies are excluded. Reports are saved under `coverage/`.
Loading