Contributing

Prerequisite

node: "^12.20.0 || ^14.13.1 || >=16.0.0"
yarn: "^1.22.10"
# otherwise, build will fail

Setting Up the Monorepo

# git clone && cd ...
yarn install
yarn build

Most of the packages have a dev script that will recompile when a file changes. For example when working on the astro package you can run:

yarn workspace astro run dev

Making Pull Requests

When making a pull request, add a changeset which helps with releases.

yarn changeset

This will prompt you asking what type of change was made.

Releases

For those contributors that have access to publish to npm, the following is how you do releases.

From the main branch do a pull, install and build:

git pull origin main
yarn install
yarn build

Then bump the versions:

yarn changeset version

This should change package.json bumping version numbers and update changelogs. Inspect these to make sure they are what you expect.

Commit and push these changes, then run an npm publish for each of the packages that have changed.

Important! Ordering publishes can be important. If @astrojs/parser changes you should publish that before astro, for example.

cd packages/astro
npm publish

Running benchmarks

We have benchmarks to keep performance under control. You can run these by running (from the project root):

yarn workspace astro run benchmark

Which will fail if the performance has regressed by 10% or more.

To update the times cd into the packages/astro folder and run the following:

node test/benchmark/build.bench.js --save
node test/benchmark/dev.bench.js --save

Which will update the build and dev benchmarks.

Translations

Help us translate docs.astro.build into as many languages as possible! This can be a great way to get involved with open source development without having to code.

Our translation process is loosly based off of MDN.

Important: Beta Status

Astro is changing quickly, and so are the docs. We cannot translate too many pages until Astro is closer to a v1.0.0 release candidate. To start, do not translate more than the "getting started" page. Once we are closer to a v1.0.0 release candidate, we will begin translating all pages.

Tier 1: Priority Languages

Tier 1 languages are considered a top priority for Astro documentation. The docs site should be fully translated into these languages, and reasonably kept up-to-date:

Simplified Chinese (zh-CN)
Traditional Chinese (zh-TW)
French (fr)
Japanese (ja)

We are always looking for people to help us with these translations. If you are interested in getting involved, please reach out to us on Discord in the i18n channel.

Tier 2 Languages

All other languages are considered Tier 2. Tier 2 language translations are driven by the community, with support from core maintainers. If you want to see the Astro docs site translated into a new language, then we need your help to kick off the project!

If you are interested in getting involved, please reach out to us on Discord in the i18n channel.

3.3 KiB Raw Blame History