From 69a6be3fd8ca5f66254e45ed9ea47ddbe6cab708 Mon Sep 17 00:00:00 2001 From: Anthony Shew Date: Fri, 17 Jan 2025 20:59:33 -0700 Subject: [PATCH 1/2] chore: Update CONTRIBUTING.md for example maintenance statuses --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4050835116b0e..ee04f953ff69a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,6 +199,11 @@ For simplicity, each example is treated as a standalone "repository", separate f To contribute to an existing example, create your code updates and submit a pull request to the repository. No special steps are required to contribute to an example. +> [!IMPORTANT] +> As Turborepo usage has grown, the community has contribute more and more examples to the repository. While this is exciting for us on the core team, we're unable to maintain the full surface area of every example, given the constant updates across the breath of tooling that Turborepo works with in the examples. +> +> Because of this, a handful of the examples are explictly marked as maintained by the core team. For the rest, we work with the community to keep them as up to date and correct as possible. If you find a problem with a community-supported template, we ask that you do not open a GitHub Issue for it. Instead, please open a pull request with the needed fixes. + ### Philosophy for new examples Turborepo works with any framework, tool, or even language. Because of this, the community often expresses interest in creating new examples to showcase Turborepo working with other tooling. From ccca463a7bc88c54ffb3d57a9b628716ab6df255 Mon Sep 17 00:00:00 2001 From: Anthony Shew Date: Fri, 17 Jan 2025 21:02:21 -0700 Subject: [PATCH 2/2] fix: put contributing update in right place --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee04f953ff69a..7ee87e5632715 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -188,6 +188,11 @@ See [the publishing guide](./release.md). Contributing to examples helps the Turborepo community by showcasing how to use Turborepo in real-world scenarios with other tools and frameworks. They can be found in [the examples directory](https://github.com/vercel/turborepo/tree/main/examples) of this repository. +> [!IMPORTANT] +> As Turborepo usage has grown, the community has contribute more and more examples to the repository. While this is exciting for us on the core team, we're unable to maintain the full surface area of every example, given the constant updates across the breath of tooling that Turborepo works with in the examples. +> +> Because of this, a handful of the examples are explictly marked as maintained by the core team. For the rest, we work with the community to keep them as up to date and correct as possible. If you find a problem with a community-supported template, we ask that you do not open a GitHub Issue for it. Instead, please open a pull request with the needed fixes. + The `basic` example is the default used by `create-turbo`. For simplicity, each example is treated as a standalone "repository", separate from the rest of the repository, with its own dependencies, lockfile, `turbo` version, etc. You are able to run code and make code updates in an example without needing to install the dependencies of the rest of the repository. @@ -199,11 +204,6 @@ For simplicity, each example is treated as a standalone "repository", separate f To contribute to an existing example, create your code updates and submit a pull request to the repository. No special steps are required to contribute to an example. -> [!IMPORTANT] -> As Turborepo usage has grown, the community has contribute more and more examples to the repository. While this is exciting for us on the core team, we're unable to maintain the full surface area of every example, given the constant updates across the breath of tooling that Turborepo works with in the examples. -> -> Because of this, a handful of the examples are explictly marked as maintained by the core team. For the rest, we work with the community to keep them as up to date and correct as possible. If you find a problem with a community-supported template, we ask that you do not open a GitHub Issue for it. Instead, please open a pull request with the needed fixes. - ### Philosophy for new examples Turborepo works with any framework, tool, or even language. Because of this, the community often expresses interest in creating new examples to showcase Turborepo working with other tooling.