Skip to content

Commit 32041c1

Browse files
authored
Update based course experiences (betatim#9)
* 📝 add instructions to globally or locally define how to handle diverging changes Situation: - local commits not on origin - new commits on branch on origin * 📝 add recipe template to instructions
1 parent 322ed74 commit 32041c1

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

instructions_251105.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,31 @@ as well or instead. Find exercise groups seeing the marks on the tables.
5353
- [create a fork](https://github.com/biosustain/recipe-book/fork)
5454
(or request access as collaborator of the the recipe-repo)
5555
- create a new branch from `main`, e.g. `add-aioli-pasta`
56-
- create a commit with your new recipe draft
56+
- create a commit with your new recipe draft using the template
57+
<details>
58+
<summary>See the recipe template</summary>
59+
60+
```markdown
61+
# Title
62+
63+
## Ingredients
64+
65+
(For 4 People)
66+
67+
- ingredient 1
68+
- ingredient 2
69+
70+
## Instructions
71+
72+
1. first step
73+
2. second step
74+
75+
```
76+
77+
Please make sure to have the headings as shown above for consistency.
78+
It will be checked.
79+
80+
</details>
5781
- open a Pull (Merge) Request on GitHub to `origin/main`
5882
- ask someone (by inviting them) to review your PR and get an approval
5983
- I set-up the repo to require at least one approval before a merge is possible

local_setup.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,18 @@ git config --global user.email "you@example.com"
1616
git config --global user.name "Your Name"
1717
```
1818
> could be added to local config using `git config user...`
19+
20+
Then you need to define how to handle merge conflicts, in case you have committed
21+
changes locally and there are changes in the remote repository. The easiest way is to
22+
always create a merge commit
23+
([docs](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pullrebase)):
24+
25+
```bash
26+
git config --global pull.rebase false
27+
# or only for this repository
28+
git config --local pull.rebase false
29+
```
30+
31+
Setting it to true has a the warning:
32+
> NOTE: (setting it to true) is a possibly dangerous operation; do not use it unless you understand
33+
> the implications. (see [git-rebase](https://git-scm.com/docs/git-rebase) for details)

0 commit comments

Comments
 (0)