geek-cookbook/manuscript/community/contribute.md

Contribute

Spread the word ❤️

Got nothing to contribute, but want to give back to the community? Here are some ideas:

1. Star ⭐ the repo
2. Tweet 🐦 the meat!

Contributing moneyz 💰

Sponsor your chef ❤️, or join us in supporting the open-source projects we enjoy!

Contributing bugfixorz 🐛

Found a typo / error in a recipe? Each recipe includes a link to make the fix, directly on GitHub:

Click the link to edit the recipe in Markdown format, and save to create a pull request!

Here's a 113-second video illustrating the process!

Contributing recipes 🎁

Want to contributing an entirely new recipe! Awesome!

GitHub Codespaces

GitHub 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, and when clicking the download button (where you're usually get the URL to clone a repo), click on "Open with CodeSpaces" instead:

You'll shortly be dropped into the VSCode interface, with mkdocs/material pre-installed and running. Any changes you make are auto-saved (there's no "Save" button), and available in the port-forwarded preview within seconds:

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

The process is basically:

1. Fork the repo
2. Clone your forked repo locally
3. Make a new branch for your recipe (not strictly necessary, but it helps to differentiate multiple in-flight recipes)
4. Create your new recipe as a markdown file within the existing structure of the manuscript folder
5. Add your recipe to the navigation by editing mkdocs.yml
6. Test locally by running ./scripts/serve.sh in the repo folder (this launches a preview in Docker), and navigating to http://localhost:8123
7. Rinse and repeat until you're ready to submit a PR
8. Create a pull request via the GitHub UI
9. The pull request will trigger the creation of a preview environment, as illustrated below. Use the deploy preview to confirm that your recipe is as tasty as possible!

Contributing skillz 💪

Got mad skillz, but neither the time nor inclination for recipe-cooking? Jump into Discord or Discourse, and help your fellow geeks with their questions, or just hang out bump up our member count!