Code Monkey home page Code Monkey logo

developing-with-github's Introduction

Developing with GitHub

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.

Seminar Details

Date: 3rd October, 2023
Time: 18:30โ€“19:30
Venue: Lecture Theatre D, Academic Building, Hong Kong University of Science and Technology
Host: @usertam

Getting Started

To get started with the tasks, follow these steps:

  1. Fork this repository to your own GitHub account. Click "Fork", then "Create Fork". The same repository should now be under your GitHub name.

  2. 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.

  3. Clone the repository to your local machine using the following command:

git clone https://<ghp_token>@github.com/<your_username>/developing-with-github.git
  1. Create a new branch feature/add-page based on the default branch:
cd developing-with-github
git checkout -b feature/add-page
  1. 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 <[email protected]>
To: Samuel Tam <[email protected]>
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
  1. 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
  1. 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.

  2. Review the changes you made and provide a clear description of the changes in the pull request. If necessary, add comments or additional information.

  3. Satisfied with the pull request? Click on the "Create pull request" button to submit it.

  4. 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.

Contributing

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.

License

The project was bootstrapped with yarn create astro. The contents under src/pages of this repository are licensed under the MIT License.

developing-with-github's People

Contributors

beginner003 avatar benbenchak avatar charlieop avatar chchanec avatar darkmmon avatar furgy2003 avatar gordonbai avatar hylamba avatar jackywong-co avatar jinro7 avatar jwanggi avatar kahng314 avatar kenken5216 avatar kflamad avatar khushichawla avatar kyuak avatar llw12345 avatar lucashimselff avatar meowcolm024 avatar moliang-wange avatar mrtumi avatar mynameisissac avatar phyeungadust avatar simar-g avatar sunny-ching avatar usertam avatar waydxd avatar ylawongabust avatar yuen1010 avatar ywangmy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.