summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSarah Rainsberger2023-05-17 16:06:27 -0300
committerGitHub2023-05-17 21:06:27 +0200
commitc4731c5829ef23d43499856fc1fd5e8c36ef6f24 (patch)
treeb7fedc7a39ae97e0c89f34951e8878f941ba3aed
parent38c2c1f1ed25d6efe6ab2637ca2d9fbcdafcd240 (diff)
downloadIT.starlight-c4731c5829ef23d43499856fc1fd5e8c36ef6f24.tar.gz
IT.starlight-c4731c5829ef23d43499856fc1fd5e8c36ef6f24.tar.bz2
IT.starlight-c4731c5829ef23d43499856fc1fd5e8c36ef6f24.zip
Add Gitpod instructions to CONTRIBUTING.md (#69)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 69d30d3f..300fa58e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,6 +36,8 @@ This repo is a “monorepo,” meaning it contains several projects in one. It c
### Setting up a development environment
+#### Developing locally
+
**Prerequisites:** Developing Starlight requires [Node.js](https://nodejs.org/en) and [pnpm](https://pnpm.io/). Make sure you have these installed before following these steps.
1. **Fork Starlight** to your personal GitHub account by clicking <kbd>Fork</kbd> on the [main Starlight repo page][sl].
@@ -58,6 +60,20 @@ This repo is a “monorepo,” meaning it contains several projects in one. It c
pnpm i
```
+#### Developing using Gitpod
+
+Instead of working locally on your machine, you can also contribute using an online coding development environment like Gitpod.
+
+**Prerequisites:** Developing Starlight using Gitpod requires a free [Gitpod account](https://gitpod.io).
+
+1. **Open the Gitpod URL** [https://gitpod.io/#https://github.com/withastro/starlight](https://gitpod.io/#https://github.com/withastro/starlight). You can alternatively install a [Gitpod browser extension](https://www.gitpod.io/docs/configure/user-settings/browser-extension) which will add a "Gitpod" button when viewing [Starlight's repo on GitHub](https://github.com/withastro/starlight).
+
+2. **Install dependencies** with `pnpm`:
+
+ ```sh
+ pnpm i
+ ```
+
### Testing changes while you work
Run the Astro dev server on the docs site to see how changes you make impact a project using Starlight.