This repository contains the resources and tasks for the seminar "Developing with GitHub". The seminar introduces GitHub's issue tracking and collaborative development features, including issues, pull requests, and actions. Here, we will try to fork the CSESS/developing-with-github.git repository, add an additional page to the fork, then submit a pull request based on the change.
Date: 3rd October, 2023
Time: 18:30–19:30
Venue: Lecture Theatre D, Academic Building, Hong Kong University of Science and Technology
Host: @usertam
To get started with the tasks, follow these steps:
-
Fork this repository to your own GitHub account. Click "Fork", then "Create Fork". The same repository should now be under your GitHub name.
-
If you haven't set up SSH authentication with GitHub: Go to upper-right corner, click on your profile photo, select "Settings". Go to left sidebar, select "Developer settings". Click on "Personal access tokens", "Tokens (Classic)". Click on "Generate new token (classic)". Enter a description (e.g., "Developing with GitHub"), select the "repo" scope, then click on "Generate token". Copy the generated token.
-
Clone the repository to your local machine using the following command:
git clone https://<ghp_token>@github.com/<your_username>/developing-with-github.git
- Create a new branch
feature/add-pagebased on the default branch:
cd developing-with-github
git checkout -b feature/add-page
- Open a new markdown file (.md) with your username, inside the directory
src/pages. Write some feedback for Samuel, praise Desmond, or write something else really nice.
cat <<'EOF' > src/pages/<your_username>.md
# Letter to the Samuel on the Podium
```
From: Samuel Tam <hytamap@ust.hk>
To: Samuel Tam <hytamap@ust.hk>
Subject: Ganbatte on the "Developing with GitHub" Seminar!!!
Date: Mon, 2 Oct 2023 23:59:59 +0800
```
Dear Future Samuel on the Podium,
Doing this seminar and everything live must be really stressful.
But I do hope both the audience and you can take home something. :)
Best,
Samuel
EOF
- Add the new file, commit the change, push to your forked repository.
git add src/pages
git commit -m "<your_username>: add page"
git status # sanity check
git log # more sanity check
git push origin feature/add-page
-
Visit your forked repository on GitHub (e.g.,
https://github.com/<your-username>/developing-with-github) and you should see a prompt to create a pull request for your branch. Click on the "Compare & pull request" button. -
Review the changes you made and provide a clear description of the changes in the pull request. If necessary, add comments or additional information.
-
Satisfied with the pull request? Click on the "Create pull request" button to submit it.
-
Once your submitted pull request is accepted, you should see your markdown content rendered under
https://csess.github.io/developing-with-github/<your_username>. For COMP4900 students, please submit your own pull request link (e.g.,https://github.com/CSESS/developing-with-github/pull/1) to Canvas.
Contributions to this repository are not expected as it is primarily meant for the seminar attendees. However, if you have any suggestions or improvements, please feel free to open an issue in the repository.
The project was bootstrapped with yarn create astro. The contents under src/pages of this repository are licensed under the MIT License.