From 750b3a33f88e0b86bb2483aa3de20ccf6e86453b Mon Sep 17 00:00:00 2001
From: Zanie Blue <contact@zanie.dev>
Date: Mon, 5 May 2025 04:49:06 -0500
Subject: [PATCH] Update contributing guide for ruff commit changes (#3)

---
 CONTRIBUTING.md | 23 +++++++++++++++++++++++
 README.md       | 36 +++++++++++++++++++++++++++++++++++-
 2 files changed, 58 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ba3da16..b285c13 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -34,3 +34,26 @@ The Python package can be built with any Python build frontend (Maturin is used
 ```
 uv build
 ```
+
+## Updating the Ruff commit
+
+To update the Ruff submodule to the latest commit:
+
+```
+git -C ruff pull origin main
+```
+
+Or, to update the Ruff submodule to a specific commit:
+
+```
+git -C ruff checkout <commit>
+```
+
+To commit the changes:
+
+```
+commit=$(git -C ruff rev-parse --short HEAD)
+git switch -c "sync/ruff-${commit}"
+git add ruff
+git commit -m 'Update ruff submodule to https://github.com/astral-sh/ruff/commit/${commit}'
+```
diff --git a/README.md b/README.md
index 5949fd4..0681838 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
 # ty
 
-This project is coming soon.
+An extremely fast Python type checker, written in Rust.
+
+**This project is still in development and is not ready for production use.**
+
+## Getting involved
+
+If you have questions or want to report a bug, please open an
+[issue](https://github.com/astral-sh/ty/issues) in this repository.
+
+Development of this project takes place in the [Ruff](https://github.com/astral-sh/ruff) repository
+at this time. Please [open pull requests](https://github.com/astral-sh/ruff/pulls) there for changes
+to anything in the `ruff` submodule (which includes all of the Rust source code).
+
+See the
+[contributing guide](https://github.com/astral-sh/ty/blob/main/CONTRIBUTING.md) for more details.
+
+## License
+
+ty is licensed under either of
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+  <https://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
+
+at your option.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ty
+by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any
+additional terms or conditions.
+
+<div align="center">
+  <a target="_blank" href="https://astral.sh" style="background:none">
+    <img src="https://raw.githubusercontent.com/astral-sh/uv/main/assets/svg/Astral.svg" alt="Made by Astral">
+  </a>
+</div>