mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-11 00:36:29 +00:00
Update contributions page
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
@@ -29,11 +29,11 @@ For the best experience, start by [creating an issue](https://github.com/geek-co
|
||||
|
||||
Once your issue has been reviewed and approved, start working on a PR using either GitHub Codespaces or local dev (below). As soon as you're ready to share your work, create a WIP PR, so that a preview URL will be generated. Iterate on your PR, marking it as ready for review when it's ... ready :grin:
|
||||
|
||||
### GitPod
|
||||
### 🏆 GitPod (free up to 50h/month)
|
||||
|
||||
https://gitpod.io/#https://github.com/geek-cookbook/geek-cookbook
|
||||
GitPod is by far the smoothest and most slick way to edit the cookbook. Click [here](https://gitpod.io/#https://github.com/geek-cookbook/geek-cookbook) to launch a browser-based editing session! 🥷
|
||||
|
||||
### GitHub Codespaces
|
||||
### 🥈 GitHub Codespaces (not free)
|
||||
|
||||
[GitHub Codespaces](https://github.com/features/codespaces) provides a browser-based VSCode interface, pre-configured for your development environment. For no-hassle contributions to the cookbook with realtime previews, visit the [repo](https://github.com/geek-cookbook/geek-cookbook), and when clicking the download button (*where you're usually get the URL to clone a repo*), click on "**Open with CodeSpaces**" instead:
|
||||
|
||||
@@ -45,7 +45,7 @@ You'll shortly be dropped into the VSCode interface, with mkdocs/material pre-in
|
||||
|
||||
Once happy with your changes, drive VSCode as normal to create a branch, commit, push, and create a pull request. You can also abandon the browser window at any time, and return later to pick up where you left off (*even on a different device!*)
|
||||
|
||||
### Editing locally
|
||||
### 🥉 Editing locally
|
||||
|
||||
The process is basically:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user