From 01b575c960480e51a360d2b9e871cb35eca2f353 Mon Sep 17 00:00:00 2001 From: David Peter Date: Tue, 13 May 2025 11:36:36 +0200 Subject: [PATCH] Contributing guide: clarifications and link (#348) ## Summary Some minor rewording and a link to the ty's main [CONTRIBUTING.md](https://github.com/astral-sh/ruff/blob/main/crates/ty/CONTRIBUTING.md) guide. --- CONTRIBUTING.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b56ac19..7d478e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,20 @@ # Contributing +> [!IMPORTANT] +> If you want to contribute changes to ty's core, please check out the +> [dedicated `ty` contributing guide](https://github.com/astral-sh/ruff/blob/main/crates/ty/CONTRIBUTING.md). +> Keep reading if you want to contribute to ty's documentation or release process instead. + ## 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. +This repository contains ty's documentation and release infrastructure. The core of ty's Rust codebase is +located in the [Ruff](https://github.com/astral-sh/ruff) repository. While the relationship between these +two projects will evolve over time, they currently share foundational crates and it's easiest to use a single +repository for the Rust development. -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. +The Ruff repository is included as a submodule inside this repository 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, check out the `main` branch of the Ruff repository. ## Getting started with the ty repository