JoinUs Guide

This is a guide for new members to join the EZ-HKUorganization. The guide will help you get started with

  • Git
  • GitHub
  • Github Flow

and provide you with a small challenge to test your skills. If you are interested in joining our organization, follow the steps below to complete the challenge.

If you are familiar with Git or GitHub or Github Flow, you can skip the guides and go directly to the challenge.

Get Started

This guide will help you get started with Git and GitHub, which are essential tools for software development.

Git

If you are working on a project with multiple people, you need a version control system. Git is a distributed version control system that allows you to track changes in your codebase. It is widely used in the software development industry.

Install

Ubuntu

sudo apt-get install git

Windows

Download and install from git-scm.com

Setup

Before you start using git, you need to set up your name and email address.

git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"

Create a Repository

To create a new git repository, run git init in the directory you want to track.

git init

Clone a Repository

To clone an existing git repository, run git clone followed by the repository URL.

git clone https://github.com/someuser/somerepo.git

Add Files

When you create a new file or modify an existing file, you need to add it to the staging area.

git add filename

When there are multiple files, you can add all of them at once.

git add .

Commit Changes

After adding files to the staging area, you need to commit them to the repository.

git commit -m "Your commit message"

Push Changes

To push your changes to the remote repository, run git push.

git push

Pull Changes

To pull changes from the remote repository, run git pull.

git pull

GitHub

Introduction

GitHub is a web-based platform used for version control. It is a platform where developers can store, share, and collaborate on projects. GitHub is built on Git, a distributed version control system. GitHub is a popular platform for open-source projects and is used by many developers to collaborate on projects.

Sign Up

To use GitHub, you need to create an account. You can sign up for a free account on the GitHub website.

Github Flow

This guide will help you understand the GitHub Flow and how to use it in the projects.

What is GitHub Flow?

GitHub Flow is a lightweight, branch-based workflow that supports teams and projects where deployments are made regularly. It is designed around the core idea that a main branch should always be deployable. This means that the main branch should contain the latest stable version of the project.

How does it work?

The GitHub Flow consists of the following steps:

  1. Create a branch: When you start working on a new feature or fix a bug, you should create a new branch from the main branch. The branch should have a descriptive name that reflects the changes you are making.
  2. Add commits: Once you have made the changes, you should commit them to the branch. Each commit should be a small, logical change that can be easily reviewed.
  3. Open a pull request: After you have committed the changes, you should open a pull request to merge the changes into the main branch. The pull request should contain a description of the changes and any relevant information.
  4. Discuss and review: The team should review the changes and discuss any issues or suggestions. The pull request should be updated based on the feedback received.
  5. Merge the changes: Once the changes have been reviewed and approved, they can be merged into the main branch. The main branch should always contain the latest stable version of the project.
  6. Deploy: After the changes have been merged, they can be deployed to the production environment. This ensures that the latest changes are available to the users.

Branches

Pull Requests

Issues

Challenge

This is a little challenge for you to solve. You need to add some changes to our public repository. Follow the steps below to complete the challenge.

Steps

To test your skills, you will be asked to change the content of the repository using github flow. Follow the steps below to complete the challenge.

  1. Fork the repository.
  2. Add a new file to the challenge/ directory. The file should contain a brief introduction about yourself. The file should be named your-username.md.
  3. Add a new line to Members block in the src/members.md file with your github username and date of submission.
  4. Commit the changes to your forked repository.
  5. Create a pull request to the original repository.

After you have completed the steps, we will review your pull request and merge it if everything is correct.

Good luck!

Tips

  • If you are new to Git and GitHub, you can refer to our Git and GitHub guides.
  • If you are not familiar with the pull request process, you can refer to the GitHub documentation.
  • The repository is public, so you can see other people's submissions as well. Feel free to check them out!

Important

  • The repository is public, so do not include any sensitive information in your file.
  • Make sure your file is in the correct directory and has the correct name.
  • If you have any questions or need help, feel free to reach out to us in discussions.

Members

  • adlsdztony
    • 2023-09-01
  • Zhonglin1231
    • 2023-11-19
  • Uynaity
    • 2024-06-18
  • Karis
    • 2024-07-02