COP4111C - Team Project

Table of contents

1. Team
2. Instructions
3. Changes
4. Issues
5. Discussions

Team

COP4111C Team 2	3/15/2022 9:07pm
COP4111C Team 2	3/15/2022 9:07pm

#	Member Name
1.	Kishon Diaz

Instructions

One team member only

Remote repository setup

One team member is to complete the following steps in the remote repository on the GitHub web site:

1. Select the Projects link.
2. Choose the Create a project button.
3. Enter a name for the project. e.g., Project 1
4. Enter a description of the project.
5. Select Automated kanban as the template.
6. Choose the Create project button.
7. Three notes were automatically added in the To do column. Read the notes and then for each note, select the ... in the top right corner of the note and select Delete note. Select OK to confirm deletion.

See About project boards for more help.

Clone remote to local repository

In GitHub:

1. Select the <> Code link.
2. Select the green Code button.
3. Ensure HTTPS is selected and click the copy button to copy the remote repository URL.

In Git Bash (Windows) or Terminal (Mac, Linux)

1. Navigate to the folder where the repository should be cloned into.
2. Issue the git clone command followed by pasting the previously copied remote repository URL.
3. Set your user name and email using the git config command. e.g., git config user.name "your name" and git config user.email "your email address".
4. Check that the correct username and email is set using the git config -l command.
5. Setting and checking user.name and user.email needs to be done every time the remote repository is cloned to a local repository.

Create a develop branch. (Only needs to be done once in a repository.)

1. Create a branch named develop off the main branch. e.g., git branch develop
2. Push the branch to the remote repository. e.g., git push -u origin develop Creation of files should not start until the develop branch has been pushed to the remote repository.
3. Switch to the develop branch. e.g., git checkout develop
4. Edit the README.md file in the local repository, then at the top, replace XXX9999X with the course number, replace the words Replace with team name with your teams' name, replace the words Replace with the current date and time with the current date/time (e.g., Monday January 10, 2022 - 11:45 AM) and replace the first Replace with full name words with your full name. Save the changes.
5. Stage the changes. e.g., git add README.md
6. Commit the changes. e.g., git commit -m "Replace course number, team date/time and name"
7. Push the changes to the remote repository. e.g., git push

Merge the develop branch to the main branch.

1. Switch to the main branch. e.g., git checkout main
2. Merge the develop branch into the main branch. e.g., git merge develop
3. Push the changes to the remote repository. e.g., git push
4. Switch to the develop branch. e.g., git checkout develop

Notify other team members that the lab repository is setup and they can join the repository.

Other team members

Wait until ALL the steps above done by one team member have been completed.

In GitHub:

1. Select the <> Code link.
2. Select the green Code button.
3. Ensure HTTPS is selected and click the copy button to copy the remote repository URL.

In Git Bash (Windows) or Terminal (Mac, Linux)

1. Navigate to the folder where the repository should be cloned into.
2. Issue the git clone command followed by pasting the previously copied remote repository URL.
3. Set your user name and email using the git config command. e.g., git config user.name "your name" and git config user.email "your email address".
4. Check that the correct username and email is set using the git config -l command.
5. Setting and checking user.name and user.email needs to be done every time the remote repository is cloned to a local repository.

Replace name in Member Name column.

1. Switch to the develop branch. e.g., git checkout develop
2. Edit the README.md file in the local repository, then at the top, replace the next words Replace with full name with your full name. Save the change.
3. Stage the change. e.g., git add README.md
4. Commit the change. e.g., git commit -m "Replace name"
5. Push the changes to the remote repository. e.g., git push

Merge the develop branch to the main branch.

1. Switch to the main branch. e.g., git checkout main
2. Merge the develop branch into the main branch. e.g., git merge develop
3. Push the changes to the remote repository. e.g., git push
4. Switch to the develop branch. e.g., git checkout develop

Changes

Steps to make changes

In GitHub:

1. Assign the issue that will be worked on to yourself. See Issues below.
2. If no issue exists, open a new issue and assign it to the project board and to yourself. e.g., Create site home page *(Ensure that the title is unique and succinct. A detailed description of what work is be completed must be entered.)
3. Double check that the issue is in the To do column of the assigned project board.
4. Move the issue to the In progress column.

In Git Bash (Windows) or Terminal (Mac, Linux):

1. Navigate to the folder where the repository was cloned into.
2. Check that the correct username and email is set using the git config -l command.
3. Switch to the develop branch and execute a git pull to get the latest code from the remote repository.
4. Create a new feature branch and switch to the new branch. e.g., git branch feature/homepage Note: Replace homepage with a word the succinctly describes the issue.
5. Add, modify and/or delete a file(s).
6. When the changes are complete:
   1. test the changes
   2. add the file(s) to the staging area
   3. commit the changes ensuring that the commit message is unique and summarizes the change
   4. switch to the develop branch
   5. execute a git pull to get the latest code from the remote repository
   6. merge the changes to the develop branch from the new branch previously created
      1. resolve merge conflicts if there are any
      2. test that the code still works after the merge conflict is fixed
      3. add the file(s) fixed from the merge conflict to the staging area
      4. commit the fixed file(s)
   7. push the develop branch to the remote repository
   8. create a pull request on the remote repository (GitHub) from the develop branch to the main branch.
   9. review the pull request and merge to the main branch on the remote repository
7. Delete the branch previously created for coding the changes from the local and remote repositories.
8. Close the issue after all required changes have been committed. This will move the issue to the Done column of the project board.

Repeat these steps each time changes are to be made. NOTE: Ensure that a git pull is regularly executed while checked out on the develop branch to get any changes that have been pushed to the develop branch by other team members.

To keep the develop and main in sync, complete the following steps in the local repository:

1. Switch to the main branch. e.g., git checkout main
2. Pull the changes from the remote repository. e.g., git pull
3. Switch to the develop branch. e.g., git checkout develop
4. Merge the main branch into the develop branch. e.g., git merge main
5. Push the changes to the remote repository. e.g., git push
6. On the remote repository the develop branch will be even with the main branch.

Issues

Open an Issue

1. In the repository, select the Issues link.
2. Choose New issue.
3. Enter a Title for the issue.
4. Enter details in the Write tab.
5. From the Projects section, select the previously created project. See Adding issues and pull requests to a project board for more help.
6. Choose Submit new issue.

Assign an Issue

1. In the repository, select the Issues link.
2. Select the issue that needs to be assigned.
3. Choose the Assignees option.
4. Select your name as the assignee to add to the issue.

Filter issues assigned to you

1. In the repository, select the Issues link.
2. Choose the Assignee drop down.
3. Select your username from the list.

Close an Issue

1. In the repository, select the Issues link.
2. Select the issue that needs to assigned to one or more group members.
3. Enter closing details in the Write tab.
4. Choose Close and comment.

Reopen a Closed an Issue

1. In the repository, select the Issues link.
2. Ensure Closed issues are displayed.
3. Select the issue that needs to be reopened.
4. Enter reopening details in the Write tab.
5. Choose Reopen issue.

See About issues for more help.

Discussions

Discussions are the official method of communication via electronic means for this lab. If the professor is asked to resolve a dispute between team members, only communications between the team members made in the repository discussions will be reviewed.

Start a discussion

1. When in the repository, select the Discussions link. If the Discussions link is not shown, contact the professor and request that discussions be enabled for the repository.
2. Choose the New discussion button.
3. Select a category.
4. Enter a title for the discussion at the top of the page.
5. Enter details in the Write tab. Use Markdown if applicable.
6. To @ mention a team member, use the @ symbol in the comment to bring up a list of repository members and choose a team member. Note: All team members of the repository and a team comprising ALL students in the class are listed. Ensure that the correct team member is being @ mentioned. Do not select the class team.
7. Choose Start discussion.

Reply to a discussion

1. When in the repository, select the Discussions link.
2. Select the title of the discussion to be replied to.
3. If replying to a comment in the discussion, enter details into the Write a reply field and then choose the Reply button.
4. If no previous comment or not replying to a comment, enter details in the Write tab. Use Markdown if applicable. Then choose the Comment button.

See About team discussions for more help.