Skip to content

README1.md

Latest commit

 

History

History
121 lines (91 loc) · 6.96 KB

README1.md

File metadata and controls

121 lines (91 loc) · 6.96 KB
Raw

Stars Badge Forks Badge Pull Requests Badge Issues Badge GitHub contributors Visitors

GitHub Workshop

Language:  · Malay  ·  English  · 

Introduction

This workshop introduces GitHub as a platform for storing project materials, producing documentation, building a digital portfolio and managing team collaboration.

The workshop focuses on the practical use of GitHub through the web interface, GitHub Desktop, Visual Studio Code and other supporting applications. Participants do not need prior experience using Git commands through the command line.

Workshop Objectives

After completing this workshop, participants will be able to:

  1. Build a GitHub profile and project repository suitable for a digital portfolio.
  2. Produce project documentation using README, Markdown, images and demo links.
  3. Use GitHub for team collaboration through Issues, Projects and Pull Requests.

Workshop Outcomes

At the end of the workshop, participants are expected to have:

  • An active GitHub account.
  • A more professional GitHub profile.
  • At least one project repository.
  • A neat and complete project README.
  • Experience using GitHub Desktop.
  • Experience collaborating in a group repository.

Workshop Materials

No. Material Content
1 Presentation Slides Basic GitHub Workshop
2 Participant Module Basic GitHub Workshop Module
3 Basic Exercises Basic GitHub Workshop Exercises
4 Mini Project GitHub Mini Project
5 Additional Exercises GitHub Pages, Copilot, VS Code and Google Colab

Case Studies

No. Resource
1 UTMSmart — Case Study Report
2 Personal Website — drshahizan.github.io
3 GitHub Repository — drshahizan.github.io
4 Mobile Application Programming
5 Software Engineering
6 RICE: Refining Instance Masks in Cluttered Environments with Graph Neural Networks
7 Awesome Artificial General Intelligence

For Participants

Before the workshop:

  • Prepare an active email address.
  • Make sure you can sign in to your email account.
  • Bring a laptop if available.
  • Make sure the computer can access GitHub through a web browser.

During the workshop:

  • Follow the exercises in sequence.
  • Save your GitHub profile link.
  • Save your project repository link.
  • Use neat file and folder names.
  • Ask the facilitator if you face technical issues.

After the workshop:

  • Update your GitHub profile.
  • Update your project README.
  • Check your project and demo links again.
  • Share your profile or repository link as a digital portfolio.

Related Software and Platforms

Platform Use
GitHub Main platform for project repositories and collaboration.
GitHub Desktop Visual application for clone, commit, push and pull.
Visual Studio Code Code editor for opening and updating project files.
Google Colab Cloud notebook for Python, data and AI exercises.
GitHub Copilot AI assistant for questions, documentation and code review.
GitHub Pages Publishing portfolio websites or project demos.

References

GitHub LinkedIn Email ResearchGate ORCID A