diff --git a/instructions_251105.md b/instructions_251105.md index 27dd5d7..2c06f50 100644 --- a/instructions_251105.md +++ b/instructions_251105.md @@ -53,7 +53,31 @@ as well or instead. Find exercise groups seeing the marks on the tables. - [create a fork](https://github.com/biosustain/recipe-book/fork) (or request access as collaborator of the the recipe-repo) - create a new branch from `main`, e.g. `add-aioli-pasta` -- create a commit with your new recipe draft +- create a commit with your new recipe draft using the template +
+ See the recipe template + + ```markdown + # Title + + ## Ingredients + + (For 4 People) + + - ingredient 1 + - ingredient 2 + + ## Instructions + + 1. first step + 2. second step + + ``` + + Please make sure to have the headings as shown above for consistency. + It will be checked. + +
- open a Pull (Merge) Request on GitHub to `origin/main` - ask someone (by inviting them) to review your PR and get an approval - I set-up the repo to require at least one approval before a merge is possible diff --git a/local_setup.md b/local_setup.md index 14d0cf3..7f5bb6e 100644 --- a/local_setup.md +++ b/local_setup.md @@ -16,3 +16,18 @@ git config --global user.email "you@example.com" git config --global user.name "Your Name" ``` > could be added to local config using `git config user...` + +Then you need to define how to handle merge conflicts, in case you have committed +changes locally and there are changes in the remote repository. The easiest way is to +always create a merge commit +([docs](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pullrebase)): + +```bash +git config --global pull.rebase false +# or only for this repository +git config --local pull.rebase false +``` + +Setting it to true has a the warning: +> NOTE: (setting it to true) is a possibly dangerous operation; do not use it unless you understand +> the implications. (see [git-rebase](https://git-scm.com/docs/git-rebase) for details)