CONTRIBUTING.md

How can you contribute to this website?

Setting up and running the site locally

gem install bundler jekyll bulma-clean-theme jekyll-remote-theme
bundle install
bundle exec jekyll serve

Before you start

Add a new branch. You can use your name as the name of the branch. Here is an example of a branch named after me.

git branch astrid
git checkout astrid

Add a new recipe

Editing the recipe in markdown

Recipes can be edited in markdown without coding. You can take recipes/dishes/mushroom_risotto.md as an example. All the recipes are in the recipes directory. The recipes are then organised by category and you need to add your recipe to the appropriate category. You can use the author field in the recipe template to indicate that you're the author of the recipe on the site.

Submitting your work

You can start by committing your changes to git. You can do this by adding the files you've worked on.

git add recipes/dishes/mushroom_risotto.md

Then you need to commit your changes.

git commit -m "I've added a recipe for mushroom risotto"

Finally, push your branch to the remote repository.

git push origin astrid

To update the website, you need to make a pull request on the github interface. You can assign this task to me.