Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/things-i-learned.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
name: Things I learned
about: Add one item for each thing you learned keep to max of 255 characters
title: "[Things I Learned]"
2-ssh-keygen-and-github
labels: ''

labels: IKnow

assignees: ''

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

name: Things I want to know
about: Describe this issue template's purpose here.
title: 'Thing I want to know: <file in title> [Thing I want to Knows]'
labels: IWantToKnow

assignees: ''

---

Please describe what you want to know in less than 255 characters

Please describe what you want to know in less than 255 characters.

30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,35 @@ To submit this assignment you need to submit the result of step #5 to canvas. W
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. 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. On the issues tab you should also create labels for "I Know", "Want to Know", and "Don't Understand". Once you create these labels then go to settings and look for the "Issues Template" and create 3 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 3 issue types.
3. Create one issue per item in your list and assign it to the correct issue template.
4. Create a new 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. Go back to your issues, click on each issue, and assign the issue to the following: assignee i.e. you, miletone i.e. the one you created 0.1.0, project documentation (set the status to todo) and create the branch for the issue.
4. Go to the "Project" board, and if you see any tasks without a status move them to the todo column.
5. Pick one task and move it to the in progress column to indicate you are going to work on it.
6. If you have not done so already clone the repository to your local and type "git fetch" to see the branch(s) for the issues you created.
7. Do a "git checkout <name of branch>" i.e. "git checkout 1-some-issue".
8. Complete the issue by adding one item to one of the 3 categories. Do a git status and make sure that only the readme is changed. If the readme just has the change then you can do a git commit -a -m "PUT A DESCRIPTIVE MESSAGE HERE". git commit with the -a flag adds all the new and modified files to the commit.
9. Push the branch back by doing a git push origin head or use the push command from the drop down in Pycharm.
10. Make a pull request (MAKE SURE YOU DO IT FOR YOUR OWN IT WILL DEFAULT TO MAKING A PULL REQUEST TO THE UPSTREAM REPOSITORY" for the branch and when you come to the part where you have to need the commit message you have to add "closes #?" the ? is whatever issue number that the pull request resolves.
11. Check the documentation board and you should see that the task has moved from in progress to done.
12. Once you have resolved an issue you should go to your partners' fork and make a pull request that to merge your issue branch.
13. Your partner will then need to create an issue to merge the pull request. You first need to save an issue and after you save it will make the right side controls active and you can select the repository / pull request you want to link and fill out the other fields like assigning the task to the milestone, assigning a developer, assiginging it to the right project with the todo status.
14. Once your partner creates the issue they need to merge the pull request and close it with the "closes #?" in the merge message.
15. On your own fork, you will want to make a pull request to yourself to merge their updated master into yours.


# Complete the Assignment By adding your issues to these 3 lists.

## Put your items here
### Things you understand so far
1. I know how to make an SSH Key and add it to Github so I dont need to login with a password
### Things you don't understand about what we are doing / web development.
1. Add items to the list
### Things you want to know next
1. How to connect viewjs to elastic search
=======
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".
Expand Down Expand Up @@ -92,3 +121,4 @@ Collaborating on GitHub:
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