mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-17 19:51:43 +00:00
41 lines
2.2 KiB
Markdown
41 lines
2.2 KiB
Markdown
# Contribute
|
|
|
|
## Spread the word ❤️
|
|
|
|
Got nothing to contribute, but want to give back to the community? Here are some ideas:
|
|
|
|
1. Star :star: the [repo](https://github.com/geek-cookbook/geek-cookbook/)
|
|
2. [Sponsor](https://github.com/sponsors/funkypenguin) :heart: the chef
|
|
3. Tweet :bird: the [meat](https://ctt.ac/Vl6mc)!
|
|
|
|
## Contributing bugfixes 🐛
|
|
|
|
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](https://static.funkypenguin.co.nz/how-to-contribute-to-geek-cookbook-quick-pr.mp4) illustrating the process!
|
|
|
|
## Contributing recipes 🎁
|
|
|
|
Want to contributing an entirely new recipe! Awesome!
|
|
|
|
The process is basically:
|
|
|
|
1. [Fork the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-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](https://github.com/geek-cookbook/geek-cookbook/tree/master/manuscript)
|
|
5. Add your recipe to the navigation by editing [mkdocs.yml](https://github.com/geek-cookbook/geek-cookbook/blob/master/mkdocs.yml#L32)
|
|
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](/community/discord/) or [Discourse](/community/discourse/), and help your fellow geeks with their questions, or just hang out bump up our member count! |