From abbf92d640a63f6ea087d444671bc794fbd80dd6 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Fri, 2 May 2025 11:41:08 -0500 Subject: [PATCH 1/2] Add `ruff` as a submodule --- .gitmodules | 3 +++ ruff | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 ruff diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..76d0b32 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "ruff"] + path = ruff + url = https://github.com/astral-sh/ruff diff --git a/ruff b/ruff new file mode 160000 index 0000000..675a5af --- /dev/null +++ b/ruff @@ -0,0 +1 @@ +Subproject commit 675a5af89af5b786a6c99870fe0cf7f841454271 From b21d26310b3d45b5b87e90375bef4319969826d1 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Fri, 2 May 2025 11:57:36 -0500 Subject: [PATCH 2/2] Add CONTRIBUTING draft --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7da4d66 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +## Repository structure + +ty's Rust crates can be found in the [Ruff](https://github.com/astral-sh/ruff) project. While the +relationship between these projects will evolve over time, they currently share foundational crates +and it's easiest to use a single repository for development. To contribute changes to ty's core, +open a pull request on the Ruff repository. + +The Ruff repository is included as a submodule to allow ty's release tags to reflect an exact +snapshot of the Ruff project. The submodule is only updated on release. To see the latest +development code, visit the Ruff repository. + +The ty repository only includes code relevant to distributing the ty project. + +## Getting started with the ty repository + +Clone the repository: + +``` +git clone https://github.com/astral-sh/ty.git +``` + +Then, ensure the submodule is initialized: + +``` +git submodule update --init --recursive +```