From cf604123fa4a4eeacf6427f4bbe2c3ba526c5949 Mon Sep 17 00:00:00 2001 From: Nate Moore Date: Mon, 30 Jan 2023 10:40:07 -0600 Subject: [PATCH] Add branches info to CONTRIBUTING (#6039) * add repo structure section * Update CONTRIBUTING.md --------- Co-authored-by: Nate Moore --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92d4c3c5103c..d2f72e1ef344 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,6 +152,21 @@ There are 3 contexts in which code executes: Understanding in which environment code runs, and at which stage in the process, can help clarify thinking about what Astro is doing. It also helps with debugging, for instance, if you’re working within `src/core/`, you know that your code isn’t executing within Vite, so you don’t have to debug Vite’s setup. But you will have to debug vite inside `runtime/server/`. +## Branches + +### `main` + +Active Astro development happens on the [`main`](https://github.com/withastro/astro/tree/main) branch. `main` always reflects the latest code. + +> **Note:** +> During certain periods, we put `main` into a [**prerelease**](https://github.com/changesets/changesets/blob/main/docs/prereleases.md#prereleases) state. Read more about [Releasing Astro](#releasing-astro). + +### `latest` + +The **stable** release of Astro can always be found on the [`latest`](https://github.com/withastro/astro/tree/latest) branch. `latest` is automatically updated every time we publish a stable (not prerelease) version of Astro. + +By default, `create-astro` and [astro.new](https://astro.new) point to this branch. + ## Releasing Astro _Note: Only [core maintainers (L3+)](https://github.com/withastro/.github/blob/main/GOVERNANCE.md#level-3-l3---core-maintainer) can release new versions of Astro._