Learning Objectives
- Utilize GitHub’s project management tools to organize and manage projects
- Practice creating issues in GitHub
- Craft informative READMEs for Git repositories
Slides
20.1 Exercise: GitHub Issues
Get back together with your partner that you collaborate for the Lobster Report.
Steps
- Navigate to the Lobster Report repository
- Go to the “Issue” tab of the repository
- Click on “New Issue”
- Give the Issue a title (Eg: Choose which plot to include in final report)
- Describe the issue and tag your collaborator by adding
@followed by their username (Practice Markdown syntax when writing the issue) - Click on Submit New Issue
Steps
- Collaborator navigates to issue (either from the email notification or going into the Issue tab in the Lobster Report repo)
- Respond Issue and include a To Do list indicating next steps (tip: Markdown syntax for list is /- [ ])
- Submit your response
Steps
- Navigate to a script in the Lobster Report Report repository
- Hover over the line you want to reference in the Issue
- Click on the line number (on the left), then click on the three dots right next to the number
- Choose the option “Reference in new issue”
- Write a description of the “issue” you want to address
- Submit Issue
- Assign Issue to Owner
Steps
- Owner navigates to issue (either from the email notification or going into the Issue tab in the Lobster Report repo)
- Add an emoji to issue submitted by Collaborator
- Add a label
- On the right side menu click on Label
- Either choose one of the default labels or create your own by selecting “Edit labels”
20.2 Exercise: Practice creating informative READMEs
You can do this either for the training_username repo, or the Lobster Report repo (make sure just one of you edits this one) or edit a personal repo from one of your projects. Make sure to include the 6 core elements: