How to Contribute
CAKEbox is a space for sharing useful resources, reflections, and examples from the community.
CAKEbox is hosted on GitHub, making it easy for you to request changes and add resources. If you’ve got something that might help others, we’d love you to add it.
Choose how you'd like to contribute
(1) Quick idea or tip
Got a quick thought, tip, or piece of advice? Add it to our Sprinkles of Knowledge.
(2) I've found a useful resource
Resource exists elsewhere
- Find the relevant theme
- Edit the page via the page icon. You’ll be taken to GitHub, where you can add your thoughts and send them over for review in just a few clicks.
- Add your link to the resource list.
Example format: Example external link
I own the resource and want to host it on CAKEbox
- Fork the repository and create a branch.
- Find the relevant theme and add your file to the folder. We recommend PDFs or MarkDown files.
- Submit your PR for review!
(3) I want to write something new
- Fork the repository and create a branch.
- Find the relevant theme and create a MarkDown file to write your resource. We recommend using the Contribution Template to get started!
- Add a title and tag so it appears automatically in the list of resources
- Submit your PR for review!
(4) I want to create a new theme
If you want to create a new theme, follow the guidance in our guide for contributing a new central theme.
How GitHub works (if you're new)
- Create a GitHub account.
- Fork the CAKEbox repository.
- Create a new branch for your changes.
- Make your changes
- Commit your changes with a clear, descriptive message.
- Open a pull request
- The committee will review your PR, provide feedback, and merge it when ready.
Helpful guides on how to contribute:
Contributing
- Editing a GitHub Pages Webpage via Web Browser
- How to make a new MarkDown contribution to CAKEbox
- Template for Contributing a new Central Theme
Need help?
If you have any questions or need guidance, please contact the committee at cake@jiscmail.ac.uk.