Add branches info to CONTRIBUTING (#6039)
* add repo structure section * Update CONTRIBUTING.md --------- Co-authored-by: Nate Moore <nate@astro.build>
This commit is contained in:
parent
3f687ee8d1
commit
cf604123fa
1 changed files with 15 additions and 0 deletions
|
@ -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/`.
|
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
|
## 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._
|
_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._
|
||||||
|
|
Loading…
Reference in a new issue