CompSoc CookBook
Hey, good lookin', whatcha got cookin'?
CompSoc Cookbook is a curated list of recipes by CompSoc Edinburgh members.
We'd love you to contribute some of your own favourite recipes! We use Git to manage our recipes, and you can see our repository here: GitHub. We try to follow professional practices where possible, so this would be a great introduction for you to learn Git, pull requests, reviewing, and getting your contribution live. See below for detailed guides!
Steps for contribution
Note; If you use the various "Add/Edit" buttons on this website, many of the following steps will be automated.
- Fork (i.e. make a copy) of the cookbook repository by navigating to the repo, and clicking on the "Fork" button at the top right.
- In your fork, create a new "branch" using the dropdown above the file list. Name it something intuitive, like "fix-typo-in-cookie-recipe" or "add-gingerbread". Select the newly created branch.
- Make your edits! Add files or edit files. Take a look at existing recipes for format guidance!
- At this stage, you can also install Git on your computer, clone your repository, and make edits there. Make sure you use
git switch
to switch branches, then make your edits, thencommit
andpush
to send your changes to your fork on GitHub!
- At this stage, you can also install Git on your computer, clone your repository, and make edits there. Make sure you use
- Submit a Pull Request (a request for CompSoc to pull your changes into the original). Explain your changes!
- Wait for somebody to review your edits, and if all goes well, it'll be merged in! At this point it's live on the website :)