Skip to content

Commit f85747a

Browse files
Merge pull request #5 from rosedu/razvand/readme/improve-wording
README: Improve wording
2 parents 5fae064 + 5d75b9d commit f85747a

1 file changed

Lines changed: 42 additions & 7 deletions

File tree

README.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ cd workshop-github/
1212

1313
And let's get going! 🚀
1414

15+
> [!NOTE]
16+
> If, at any point in time, you miss a command, or something bad simply happened, reset the environment by running:
17+
>
18+
> ```console
19+
> ./gh-reset-repo.sh
20+
> ```
21+
22+
> [!IMPORTANT]
23+
> We re recommend you write all commands below by hand, i.e. without using copy & paste.
24+
> This will get you better accustomed to GitHub-related commands.
25+
1526
## View GitHub Repositories
1627
1728
Take a look at the following repositories:
@@ -32,7 +43,7 @@ Do a tour of as much information as possible about them:
3243
Take a look at the [GitHub projects for the `unikraft` organization](https://github.com/orgs/unikraft/projects).
3344
Browse the projects.
3445
35-
Look at the [`Release - Next` GitHub project](https://github.com/orgs/unikraft/projects/47).
46+
Look at the [`Release - Next` GitHub project](https://github.com/orgs/unikraft/projects/49).
3647
Browse the items in the list.
3748
Browse different views (tabs) in the projects.
3849
@@ -89,10 +100,31 @@ git clone https://github.com/nodejs/node
89100

90101
For each repository, use the GitHub CLI tool to:
91102

92-
- List repository issues with `gh issue list`.
93-
- List repository pull requests with `gh pr list`.
94-
- List repository pull requests whose state is `closed` with `gh pr list -s closed`.
95-
- View details about a pull request with `gh pr view <PR_ID>`.
103+
- List repository issues:
104+
105+
```console
106+
gh issue list
107+
```
108+
109+
- List repository pull requests:
110+
111+
```console
112+
gh pr list
113+
```
114+
115+
- List repository pull requests whose state is `closed`:
116+
117+
```console
118+
gh pr list -s closed
119+
```
120+
121+
- View details about a pull request:
122+
123+
```console
124+
gh pr view <PR_ID>
125+
```
126+
127+
where `<PR_ID>` is the PR number.
96128

97129
## Create Work GitHub Repository
98130

@@ -224,7 +256,8 @@ For this, do the following:
224256
1. Ask someone around you for their GitHub username.
225257
Add them to the repository as collaborator.
226258

227-
1. Ask them to confirm the invite via e-mail or by accessing the invitation URL: `https://github.com/<your-github-username>/workshop-github/invitations`
259+
1. Ask them to confirm the invite via e-mail or by accessing the invitation URL: `https://github.com/<your-github-username>/workshop-github/invitations`.
260+
Replace `<your-github-username>` with your GitHub username.
228261

229262
1. Ask them to approve your pull request.
230263

@@ -284,7 +317,7 @@ Before this, do a reset of your repository:
284317
./gh-reset-repo.sh
285318
```
286319

287-
Each of view should now:
320+
Each of you should do the following:
288321

289322
1. Create of fork of the other's repository.
290323
Be sure to give it a different name, not to clash with your own `workshop-github` repository name.
@@ -296,6 +329,8 @@ Each of view should now:
296329
cd <clone_directory>
297330
```
298331

332+
where `<fork_url>` is the URL of the other's repository, and `<clone_directory>` is the directory of the repository clone.
333+
299334
1. Create a branch and commit(s) from `c-bye`.
300335

301336
1. Push the branch to the `origin` remote (belonging to your fork).

0 commit comments

Comments
 (0)