Skip to content

Commit 08acd6e

Browse files
committed
cosmetics/consistency adjustments in forking workflow
1 parent ee12d59 commit 08acd6e

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

content/forking-workflow.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ accept modifications without having to grant write access to others.
5656
**Technical requirements**:
5757
- If you create the commits locally: [Being able to authenticate to GitHub](https://coderefinery.github.io/installation/ssh/)
5858

59-
**What is familiar** from the previous workshop days:
59+
**What is familiar** from the previous episodes:
6060
- Forking a repository ([previous lesson](https://coderefinery.github.io/git-intro/browsing/))
6161
- Creating a branch ([previous lesson](https://coderefinery.github.io/git-intro/commits/))
6262
- Committing a change on the new branch ([previous lesson](https://coderefinery.github.io/git-intro/commits/))
@@ -112,12 +112,12 @@ The simpler solution is to clone again but this time your fork.
112112
But if you want to keep your local changes, you can change the remote URL to point to your fork.
113113
Check where your remote points to with `git remote --verbose`.
114114

115-
It should look like this (replace `your-user` with your GitHub username):
115+
It should look like this (replace `USER` with your GitHub username):
116116
```console
117117
$ git remote --verbose
118118

119-
origin git@github.com:your-user/forking-workflow-exercise.git (fetch)
120-
origin git@github.com:your-user/forking-workflow-exercise.git (push)
119+
origin git@github.com:USER/forking-workflow-exercise.git (fetch)
120+
origin git@github.com:USER/forking-workflow-exercise.git (push)
121121
```
122122

123123
It should **not** look like this:
@@ -130,7 +130,7 @@ origin git@github.com:cr-workshop-exercises/forking-workflow-exercise.git (push)
130130

131131
In this case you can adjust "origin" to point to your fork with:
132132
```console
133-
$ git remote set-url origin git@github.com:your-user/forking-workflow-exercise.git
133+
$ git remote set-url origin git@github.com:USER/forking-workflow-exercise.git
134134
```
135135
:::
136136

@@ -181,7 +181,7 @@ Click on the "Details" link to see the details of the failed test:
181181
locally.
182182

183183
**How does it work?**
184-
- We added a [GitHub Actions workflow](https://github.com/coderefinery/recipe-book-template/blob/main/.github/workflows/check-recipes.yml)
184+
- We added a GitHub Actions workflow
185185
to automatically run on each push or pull request towards the `main` branch.
186186

187187
What tests or steps can you image for your project to run automatically with
@@ -190,8 +190,7 @@ each pull request?
190190

191191
### How to update your fork with changes from upstream
192192

193-
This used to be difficult but now it is two mouse clicks.
194-
193+
This used to be difficult but now it is two mouse clicks:
195194
Navigate to your fork and notice how GitHub tells you that your fork is behind.
196195
In my case, it is 9 commits behind upstream. To fix this, click on "Sync fork"
197196
and then "Update branch":
@@ -246,10 +245,9 @@ After the update my "branch is up to date" with the upstream repository:
246245
:::
247246

248247

249-
250248
## Summary
251249

252250
- This forking workflow lets you propose changes to repositories for
253-
which *you have no access*.
251+
which **you have no write access**.
254252
- This is the way that much modern open-source software works.
255253
- You can now contribute to any project you can view.

0 commit comments

Comments
 (0)