Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2bb6012
Update issue templates
kaw393939 Feb 15, 2023
df42500
Merge pull request #8 from NJIT-WIS/kaw393939-patch-1
kaw393939 Feb 15, 2023
962b2c9
added idea folder to gitignore
Feb 15, 2023
5119c09
added whatever
Feb 15, 2023
cd4745d
Merge pull request #15 from NJIT-WIS/12-another-problem closes #12
kaw393939 Feb 15, 2023
1f93011
Update issue templates
kaw393939 Feb 16, 2023
e136125
Merge pull request #17 from NJIT-WIS/kaw393939-patch-2
kaw393939 Feb 16, 2023
d1b819e
added ssh keygen issue #19
Feb 16, 2023
492eef1
Merge pull request #20 from NJIT-WIS/19-ssh-keygen-and-github closes #19
kaw393939 Feb 16, 2023
f3b6eb0
did this up
Feb 16, 2023
40217f8
Merge pull request #26 from NJIT-WIS/24-i-learned-github-issues close…
kaw393939 Feb 16, 2023
bf78534
Update README.md
kaw393939 Feb 16, 2023
2f1db8a
Update README.md
kaw393939 Feb 16, 2023
34c37a1
Merge pull request #27 from NJIT-WIS/readme-edits
kaw393939 Feb 16, 2023
6566fc3
added that I am lost to the list
Feb 16, 2023
3b2ed7b
Merge pull request #30 from NJIT-WIS/29-i-dont-know-anything-im-total…
kaw393939 Feb 16, 2023
90b8b28
Update issue templates
kaw393939 Feb 16, 2023
787d232
added something to list
Feb 16, 2023
3225474
Merge pull request #34 from NJIT-WIS/33-something closes #33
kaw393939 Feb 16, 2023
7fae7b6
added something
Feb 16, 2023
481bb85
Merge pull request #35 from NJIT-WIS/32-i-dont-know-how-to-do-anythin…
kaw393939 Feb 16, 2023
914f74f
Update README.md
kaw393939 Feb 16, 2023
bc4a4b6
Update README.md
kaw393939 Feb 16, 2023
77095c2
Update README.md
kaw393939 Feb 16, 2023
2d9598f
Update README.md
kaw393939 Feb 16, 2023
8b9efd8
Update README.md
kaw393939 Feb 16, 2023
a5abdf5
Update README.md
kaw393939 Feb 17, 2023
0745d4d
Update issue templates
kaw393939 Feb 17, 2023
1d094ac
Update issue templates
se6-njit Feb 17, 2023
f30c90e
Update issue templates
se6-njit Feb 17, 2023
a1f6f70
Update README.md
se6-njit Feb 18, 2023
5e7a9bb
First 'do no understand' item
iamStephenE Feb 18, 2023
315958b
Merge branch 'main' into 1-how-git-stash-works
AryanNesti Feb 19, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/completed-lists.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Completed Lists
about: This is for your master pull request to merge your master into this repo.
title: Put your UCID as the title (replace this text).
labels: Master List
assignees: ''

---

You need to make a pull request and add the link to the pull request to this issue when you submit.

PULL REQUEST LINK:

UCID:
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/things-i-don-t-understand.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: Things I don't understand
about: Please add one item that you don't understand
title: "[Don't Understand]"
name: Things I Don't Understand
about: This is for adding issues that you don't understand
title: Things I Don't Understand
labels: Don't Understand
assignees: ''

---

Please add one item that you learned. File new issues for each item that you learned. Please keep the number of characters to no more than 255.
I don't understand <fill in what you don't here>
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/things-i-learned.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Things I learned
about: Add one item for each thing you learned keep to max of 255 characters
title: "[Things I Learned]"
labels: I know
title: Things I Learned/Know Now
labels: I Know
assignees: ''

---
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/things-i-want-to-know.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: Things I want to know
about: Describe this issue template's purpose here.
title: ''
labels: Want to know
title: Thing I want to Know
labels: Want to Know
assignees: ''

---


Please describe what you want to know in less than 255 characters.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea
166 changes: 115 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,86 +2,150 @@

## Overview

The purpose of this assignment is to practice collaborating using GIT/GitHub and develop the requirements for the mywebclass.org website's tutorials and courses. To accomplish this task we are going to create three lists(What I Know, What I Don't Know, and What I Want To Learn) and consolidate the items from everyone in the class into a master list that counts the number of repeated issues. You need at least **3 items for each list for a total of 9 items** and you should plan that these items are going to be used for project 1 as the basis for the possible topics that people can choose to build online tutorials about.
The purpose of this assignment is to practice collaborating using GIT/GitHub and
develop the requirements for the mywebclass.org website's tutorials and courses.
To accomplish this task we are going to create three lists(What I Know, What I
Don't Know, and What I Want To Learn) and consolidate the items from everyone in
the class into a master list that counts the number of repeated issues. You need
at least **3 items for each list for a total of 9 items** and you should plan
that these items are going to be used for project 1 as the basis for the
possible topics that people can choose to build online tutorials about.

## Learning Objectives:
1. You will learn to collaborate online using GIT
2. You will learn to merge pull requests and resolve merge conflicts
3. You will learn to manage a basic project using GitHub Project.

### Complete the Assignment By adding your issues to these 3 lists and count how many times each issue is mentioned. The number in the bracket next to each issue is the count, you should set your count at 1 for your issue. We need the count of how many times the issue is mentioned, so that we can prioritze each issue.
1. You will learn to collaborate online using GIT
2. You will learn to merge pull requests and resolve merge conflicts
3. You will learn to manage a basic project using GitHub Project.

### Your list should look like this:
### Complete the Assignment By adding your issues to these 3 lists and count how many times each issue is mentioned. The number in the bracket next to each issue is the count, you should set your count at 1 for your issue. We need the count of how many times the issue is mentioned, so that we can prioritze each issue.

#### Things we understand**
#### Things we understand

#### Things we don't understand

#### Things we want to know next**
1. How git stash works [1]

#### Things we want to know next

## Prerequisite - YOU. MUST SETUP PRIVATE PUBLIC KEY AUTH WITH GITHUB OR YOU WILL GET ACCESS DENIED ERRORS WHEN YOU PUSH FROM THE TERMINAL
Add your ssh public key to github - See video
**open powershell or terminal and run "ssh-keygen -b 4096" and hit enter through the prompts and then open the file **your home directory/.ssh/id_rsa.pub** and copy that text into your github account settings under SSH/GPG keys -> add key. in one of the prompts it will tell you where it is going to save the key. If you already have a key reusue the one you have and cancel out of the process with control c **. I do it on my mac with the command vi ~/.ssh/id_rsa.pub" and then i press shift colon : and q to quit

Add your ssh public key to github - See video **open powershell or terminal and
run "ssh-keygen -b 4096" and hit enter through the prompts and then open the
file **your home directory/.ssh/id_rsa.pub** and copy that text into your github
account settings under SSH/GPG keys -> add key. in one of the prompts it will
tell you where it is going to save the key. If you already have a key reusue the
one you have and cancel out of the process with control c **. I do it on my mac
with the command vi ~/.ssh/id_rsa.pub" and then i press shift colon : and q to
quit

### [Assignment Video](https://youtu.be/UFLKojO3OtM)

## You will accomplish this assignment in 5 phases:

1. Each person will follow the instructions below to create one issue per list item i.e. 9 issues.
**You need one issue per item in your list for a total of 9 issues.**. Resolve each issue to add each of your items to the appropriate list.

2. Find a person in class and then make a pull request for each item on your list to **THEIR** repository. **You make 9 pull requests to someone else**

This person should then merge the pull requests and resolve the merge conflict to add new items to their list and increment the count on dupilicate items. We want to know how many people said the same thing, so that we can prioritize the requirement, when we decide on what to make in project 1.

3. **Once you have merged the pull requests from someone else in class**, you need to find someone new in class to submit a pull request called "merge my list". that asks to merge your master into their master, so that they can add new items to their list and increment the duplicate issue count for each item in the list. Create an issue using the template "Assignment Master List" and reference the pull request that you make in the issue. Make sure you make a issue template to accept this issue on your own repository and provide these instructions.

4. The person that receives the pull request from #3 needs to resolve merge conflics and merge, so that the new issues are added and duplicate counts are incrimented as necessary.

5. Once you have merged someone else's combined list into your project make an issue and a pull request to the "complete_list" branch on the upstream repository i.e. the one you forked from. Use the issue "Complete List" and put a link to the pull request. Submit a link to the **issue** to Canvas to finish the assignment. In your pull request include your UCID, course number, and section.
1. Each person will follow the instructions below to create one issue per list
item i.e. 9 issues. **You need one issue per item in your list for a total of
9 issues.**. Resolve each issue to add each of your items to the appropriate
list.

2. Find a person in class and then make a pull request for each item on your
list to **THEIR** repository. **You make 9 pull requests to someone else**

This person should then merge the pull requests and resolve the merge conflict
to add new items to their list and increment the count on dupilicate items. We
want to know how many people said the same thing, so that we can prioritize the
requirement, when we decide on what to make in project 1.

3. **Once you have merged the pull requests from someone else in class**, you
need to find someone new in class to submit a pull request called "merge my
list". that asks to merge your master into their master, so that they can add
new items to their list and increment the duplicate issue count for each item
in the list. Create an issue using the template "Assignment Master List" and
reference the pull request that you make in the issue. Make sure you make a
issue template to accept this issue on your own repository and provide these
instructions.

4. The person that receives the pull request from #3 needs to resolve merge
conflics and merge, so that the new issues are added and duplicate counts are
incrimented as necessary.

5. Once you have merged someone else's combined list into your project make an
issue and a pull request to the "complete_list" branch on the upstream
repository i.e. the one you forked from. Use the issue "Complete List" and
put a link to the pull request. Submit a link to the **issue** to Canvas to
finish the assignment. In your pull request include your UCID, course number,
and section.

### You are done when you have completed the following:

1. Added your issues individually and resolved them
2. Made 9 pull requests to another person for each item that contains the branch you want to merge
3. Merged 9 pull requests from someone else
3. Made a pull request to another person with your master branch that contains the consolidated list
4. Merged the pull request of someone elsesa compiled list
5. Submmited a pull request to this repository to have your complete list merged

1. Added your issues individually and resolved them
2. Made 9 pull requests to another person for each item that contains the branch
you want to merge
3. Merged 9 pull requests from someone else
4. Made a pull request to another person with your master branch that contains
the consolidated list
5. Merged the pull request of someone elsesa compiled list
6. Submmited a pull request to this repository to have your complete list merged

### Canvas Submission instructions

To submit this assignment you need to submit the result of step #5 to canvas. When you look at the commits for your project you should see a total of 3 different users have contributed items to the list **including yourself** . If you don't have at least 3 people's commits on the project you will lose 33 points for each person not found.
To submit this assignment you need to submit the result of step #5 to canvas.
When you look at the commits for your project you should see a total of 3
different users have contributed items to the list **including yourself** . If
you don't have at least 3 people's commits on the project you will lose 33
points for each person not found.

## Project Setup Instructions
Collaborating on GitHub:

1. Fork the repository: Each person should fork the repository to their own GitHub account. To do this, click the "Fork" button in the top-right corner of the repository page.
2. Enable issues: If you don't see the "Issues" tab in the main menu, you should enable it in the repository settings.
3. Go to the "Issues" tab, and click "Milestones" to add a 0.1.0 milestone and describe it as a consolidated list of issues from your team.
4. Go to the issues tab you should also create labels for "I Know", "Want to Know", "Don't Understand", and "Master List".
5. Once you create these labels then go to settings and look for the "Issues Template" and create/edit 4 issue templates that will provide the starting text for each issue filed of that type. At the bottom of each issue you will see that you can automaticly assign a label to that issue type, so connect the respective labels you created with the 4 issue types. You need an issue for "I Know", "Want to Know", "Don't Understand", and "Master List".
4. Goto the project tab and create a new project (you have to click the down arrow next to "link project" to change it to new project). When you create a project you need to select "board" and name it "Documentation Tasks".
5. Once this is completed then clone this to your computer using the SSH link **NOT THE HTTP LINK** you need the ssh link to use the key you added to your account, so you don't get an error when pushing.
Collaborating on GitHub:

1. Fork the repository: Each person should fork the repository to their own
GitHub account. To do this, click the "Fork" button in the top-right corner
of the repository page.
2. Enable issues: If you don't see the "Issues" tab in the main menu, you should
enable it in the repository settings.
3. Go to the "Issues" tab, and click "Milestones" to add a 0.1.0 milestone and
describe it as a consolidated list of issues from your team.
4. Go to the issues tab you should also create labels for "I Know", "Want to
Know", "Don't Understand", and "Master List".
5. Once you create these labels then go to settings and look for the "Issues
Template" and create/edit 4 issue templates that will provide the starting
text for each issue filed of that type. At the bottom of each issue you will
see that you can automaticly assign a label to that issue type, so connect
the respective labels you created with the 4 issue types. You need an issue
for "I Know", "Want to Know", "Don't Understand", and "Master List".
6. Goto the project tab and create a new project (you have to click the down
arrow next to "link project" to change it to new project). When you create a
project you need to select "board" and name it "Documentation Tasks".
7. Once this is completed then clone this to your computer using the SSH link
**NOT THE HTTP LINK** you need the ssh link to use the key you added to your
account, so you don't get an error when pushing.

### Project management and Collaboration workflow Steps

1. create an issue
2. assign issue to project task
* Assign to yourself
* Assign to correct project board
* Assign to "todo" project status
* Assign to the correct milestone
* create issue branch
3. Go to the project board and move the task you created to in progress

- Assign to yourself
- Assign to correct project board
- Assign to "todo" project status
- Assign to the correct milestone
- create issue branch

3. Go to the project board and move the task you created to in progress
4. git fetch origin to see new branch
5. checkout issue branch locally
6. git status to make sure you don't have any changed files in the branch before you work
7. Resolve the issue by adding the list item or incrementing the count of the item
8. commit -a -m "message text" to do the commit
6. git status to make sure you don't have any changed files in the branch before
you work
7. Resolve the issue by adding the list item or incrementing the count of the
item
8. commit -a -m "message text" to do the commit
9. git push origin head <- pushes current branch to github
10. Do a pull request for the branch and make sure you pick the correct source and destination. Click compare forks because by default it will go to the upstream repository i.e. mine
11. merge the pull request and add "closes #<issue number> i.e. closes #4 to close the issue
12. Check that your task is moved from in progress to done
13. update your local main branch with the changes from the merge by doing git pull origin main
10. Do a pull request for the branch and make sure you pick the correct source
and destination. Click compare forks because by default it will go to the
upstream repository i.e. mine
11. merge the pull request and add "closes #<issue number> i.e. closes #4 to
close the issue
12. Check that your task is moved from in progress to done
13. update your local main branch with the changes from the merge by doing git
pull origin main
14. Repeat again, and again, and again