Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

126 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Software Engineering – Team 1 GitHub Repository

CS416 – Software Engineering | Dr. Dai

This repository serves as the central hub for Team 1’s projects and assignments.
It supports structured collaboration, version control, and streamlined submission of coursework.

⚠️ Commands below include both Windows (CMD/PowerShell) and macOS/Linux (Unix) where applicable.


1. Cloning the Repository (First-Time Setup Only)

Step A: Navigate to Your Desired Project Directory

Move to the folder where you want the repository stored.

Windows (CMD / PowerShell)

cd C:\Users\YourUsername\exampleFolderName

macOS / Linux (Unix)

cd ~/exampleFolderName

🔎 Always verify your file path before cloning.


Step B: Clone the Repository

  1. Go to GitHub.
  2. Click the green Code button.
  3. Copy the HTTPS URL.
  4. Run:
git clone PASTE_THE_HTTPS_URL_HERE

Step C: Enter the Repository Folder

cd repo-folder-name

2. Pulling the Latest Changes (Before Starting Work)

Always update your local repository first.

If on main:

git pull

If on another branch:

git pull origin your-branch-name

3. Checking Repository Status

Check staged and unstaged files:

git status

View file changes:

git diff

Use these commands frequently.


4. Creating Files and Folders (Without Using GUI)

For a seamless terminal-based workflow, use the following commands.


Creating a Folder

Windows (CMD / PowerShell)

mkdir FolderName

macOS / Linux (Unix)

mkdir FolderName

Create nested folders:

mkdir FolderName/SubFolderName

Creating a New File

Windows (CMD)

type nul > filename.txt

Windows (PowerShell)

New-Item filename.txt

macOS / Linux (Unix)

touch filename.txt

Creating a File Inside a Specific Folder

Windows

type nul > FolderName\filename.py

macOS / Linux

touch FolderName/filename.py

Renaming a File

Windows

rename oldname.txt newname.txt

macOS / Linux

mv oldname.txt newname.txt

Moving a File to Another Folder

Windows

move filename.txt FolderName\

macOS / Linux

mv filename.txt FolderName/

Deleting a File

Windows

del filename.txt

macOS / Linux

rm filename.txt

Deleting a Folder

Windows

rmdir FolderName

Delete non-empty folder:

rmdir /s FolderName

macOS / Linux

rm -r FolderName

5. Creating a New Branch (Recommended Workflow)

🚫 Do NOT work directly on main unless instructed.

Create and switch to a new branch:

git checkout -b yourname-AssignmentRequiredNamingConvention

Example Branch Names

git checkout -b Daniel-Hw1PythonMergeSort
git checkout -b Chase-Hw1JuliaQuickSort

Include your name for accountability and clarity.


6. Saving Changes (Add + Commit)

Stage Changes

Add all files:

git add .

Add a specific file:

git add path/to/file

Commit Changes

git commit -m "Short description of what you did"

Example Commit Messages

  • Completed Python Merge Sort implementation
  • Fixed edge case in Quick Sort
  • Updated README instructions

Use clear and professional messages.


7. Pushing Changes to GitHub

First Push of a New Branch

git push -u origin Daniel-Hw1PythonMergeSort

After First Push

git push

8. Opening a Pull Request (PR)

  1. Go to the repository on GitHub.
  2. Click Compare & pull request.
  3. Add a clear title and description.
  4. Submit the PR.
  5. Wait for approval from at least two team members before merging.

9. Syncing Your Branch with main

Before pushing large changes:

git checkout main
git pull
git checkout Daniel-Hw1PythonMergeSort
git merge main

If conflicts appear, resolve them before pushing.


10. Common Recovery Commands

Discard Uncommitted Changes

git reset --hard

Unstage Files

git reset

Amend Commit Message (If Not Pushed Yet)

git commit --amend -m "Improved commit message"

View and Switch Branches

git branch
git checkout branch-name

11. Standard Daily Workflow

Follow this process every time:

  1. Pull latest changes:
git pull
  1. Make changes.

  2. Check status:

git status
  1. Stage and commit:
git add .
git commit -m "Describe your changes"
  1. Push:
git push
  1. Open a Pull Request on GitHub.

Collaboration Guidelines

  • Do not push directly to main
  • Use descriptive branch names
  • Write meaningful commit messages
  • Always open a PR before merging
  • Keep communication clear within the team
  • Prefer terminal-based file management for consistency across environments

Team 1 – CS416 Software Engineering
Professional collaboration through structured version control.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages