Get a Jumpstart on Collaboration and Code Review in GitHub- PyLadies Southwest Florida

Transcript

1. Get a Jumpstart on Collaboration and Code Review in GitHub By Katherine “Kati” Michel
2. Welcome!
3. About Me • Pinax Maintainer/Web Developer • DjangoCon US Website Co-Chair • DEFNA (Django Events Foundation North America) Board Member Twitter: @KatiMichel GitHub: KatherineMichel
4. Talk Goal I want to teach you a process that will get you started collaborating and doing code review as quickly as possible
5. Good News! • This isn’t about how much you know… this is about knowing enough to be proficient
6. Good News! • Git and GitHub are a highly valuable, “gateway” skill... becoming proficient leads to many other opportunities
7. More Good News… Hacktoberfest! • A month-long celebration • Four PRs = shirt and swag • Great time to contribute https://hacktoberfest.digitalocean.com/
8. Announcing TacoFancy!
9. One Life Changing Question
10. My First Pull Request
11. DjangoCon US Website as an Example Project DjangoCon US Website Homepage DjangoCon US Website Repo
12. Prerequisites for Getting Started • Create a free GitHub account online • Install Git on your computer • Find and open your command line (a.k.a. terminal) on your computer • Be able to navigate via command line (See Bash commands) • You might also want to have a code/text editor of your choice installed
13. Housekeeping • Even though I use the word “code” in the title, this is more about the process and not specific to code • GitHub provides assistance by operating system: https://docs.github.com/en/github/using-git
14. What are Git and GitHub? GitHub is a website built on the version control software Git. GitHub Website Git Command Line
15. Social Network Make a User Profile Follow People Follow Activity in Newsfeed Find Interesting Projects
16. Repositories GitHub users work on code together DjangoCon US Organization Account Repo List
17. Repositories GitHub users work on code together DjangoCon US Organization Account Repo List
18. Repositories GitHub users work on code together DjangoCon US Organization Account Repo List DjangoCon US Website Repo
19. Local Dev Environment
20. Local Dev Environment $ git clone https://github.com/KatherineMichel/2017.djangocon.us
21. Local Dev Environment $ git clone https://github.com/KatherineMichel/2017.djangocon.us
22. Workflow Overview • Determine which collaboration approach to use • Learn about branches • Work on a branch in a local development environment, push the branch to GitHub, and submit a pull request • Review the two different types of pull requests as a maintainer • Hacktoberfest… how to get started!
23. Workflow Overview • Determine which collaboration approach to use
24. The Two Collaborative Development Models • “Shared Repository” Model • “Fork and Pull” Model
25. Two Types of Accounts Organization Account User Account
26. Write Permission When a user has write permission to a repo, it means they can make changes directly inside of the repo
27. Examples of What Write Permission Will Allow You to Do • Edit files • Push branches directly to the repo (instead of via fork) • Merge and close pull requests
28. Why We Need Write Permission DjangoCon US Website DjangoCon US Website Repo
29. Write Permission and Collaboration Examples Shared Repository DjangoCon US Website Repo Write Permission: Maintainers
30. Fork Submit Pull Request Fork and Pull Fork Write Permission: User Write Permission and Collaboration Examples Shared Repository DjangoCon US Website Repo Write Permission: Maintainers
31. How to Fork a Repo Click the “Fork” button Click pencil icon to try to edit a file you don’t have write permission to DjangoCon US Website Repo
32. How to Fork a Repo Click the “Fork” button DjangoCon US Website Repo GitHub will notify you that the repo is being forked Click pencil icon to try to edit a file you don’t have write permission to
33. Forked Repo User Account www.github.com/KatherineMichel
34. Forked Repo User Account www.github.com/KatherineMichel
35. Forked Repo User Account Forked Repo www.github.com/KatherineMichel/2017.djangocon.us
36. Workflow Overview • Determine which collaboration approach to use • Learn about branches
37. Branches are a best practice that help us better manage workflow
38. Working on a File in GitHub File on GitHub (README) Editing File Click pencil icon Edit Commit Info Save
39. Benefits to Using Branches • To keep your main branch stable • To work on features outside of the main branch, which may also take time • So that you can test and review code before merging it into your main branch
40. Branches Main Branch
41. Branches Main Branch Feature Branch
42. Branches Main Branch Feature Branch Feature Branch
43. Branches Main Branch Feature Branch Feature Branch Feature Branch
44. Branches Main Branch Feature Branch Pull Request Branch Feature Branch Feature Branch
45. How to Create a Branch File on GitHub (README) Editing File Click pencil icon Edit Commit Info Save
46. How to Create a Branch New branch and name File on GitHub (README) Editing File
47. Workflow Overview • Determine which collaboration approach to use • Learn about branches • Work on a branch in a local development environment, push the branch to GitHub, and submit a pull request
48. DjangoCon US Website Repo Fork and Pull Model
49. DjangoCon US Website Repo Fork and Pull Model My Fork Fork
50. DjangoCon US Website Repo remote origin Fork and Pull Model My Fork Fork Clone Local Development Environment
51. DjangoCon US Website Repo remote origin Fork and Pull Model My Fork Fork Clone Push changes, including branches Local Development Environment
52. DjangoCon US Website Repo remote origin Fork and Pull Model My Fork Fork Submit Pull Request Clone Push changes, including branches Local Development Environment
53. DjangoCon US Website Repo Shared Repository
54. DjangoCon US Website Repo remote origin Shared Repository Clone Local Development Environment
55. DjangoCon US Website Repo Push branches, submit pull requests remote origin Can push or pull because of write permission, No fork needed Shared Repository Clone Local Development Environment
56. Bash Commands Go to the home directory $ cd Change directory $ cd <directory-name> Move back a directory $ cd .. List the folders and files in a directory $ ls
57. Local Dev Environment Working within home directory: katherinemichel
58. Cloning $ git clone https://github.com/KatherineMichel/2017.djangocon.us
59. Cloning $ git clone https://github.com/KatherineMichel/2017.djangocon.us
60. Changing Directory $ cd 2017.djangocon.us
61. Changing Directory Working within new directory: 2017.djangocon.us
62. GitHub Repo Versus Local Directory DjangoCon US GitHub Repo Local Directory
63. Verifying Branch $ git branch
64. Creating a New Branch $ git checkout -b example-branch
65. Working on a File Locally
66. Adding and Committing $ git add . $ git commit -m “Creating branch and updating”
67. Pushing $ git push origin example-branch
68. New Branch Branch Tab
69. New Branch Branch Tab New Branch
70. Submit a Pull Request DjangoCon US Website Repo Creating a New Pull Request
71. Submit a Pull Request DjangoCon US Website Repo Creating a New Pull Request Title and Description Look over changes Create Choose branches
72. Workflow Overview • Determine which collaboration approach to use • Learn about branches • Work on a branch in a local development environment, push the branch to GitHub, and submit a pull request • Review the two different types of pull requests as a maintainer
73. Pull Request Review Process Look over changes Title and Description
74. Pull Request Review Process Look over changes Title and Description Merge button Command line instructions
75. Pull Request Command Line
76. Pull Request Review Shared Repo Branch Forked Repo Branch $ git fetch origin $ git checkout -b <branch-name> origin/<branch-name> $ git merge main $ git push origin <branch-name> $ git checkout -b <branch-name> main $ git pull https://github.com/<user-name>/<repo-name> <branch-name> $ git push https://github.com/<user-name>/<repo-name> <branch-name>
77. Workflow Overview • Determine which collaboration approach to use • Learn about branches • Work on a branch in a local development environment, push the branch to GitHub, and submit a pull request • Review the two different types of pull requests as a maintainer • Hacktoberfest… how to get started!
78. Sandboxing Create a repo and use it to practice your workflow https://guides.github.com/activities/hello-world/
79. Simple, But Effective You have cloned and cd into the directory Check branch $ git branch Update main branch $ git pull Create a new branch $ git checkout -b <branch-name>
80. Simple, But Effective Make our change… Add and commit changes $ git add . $ git commit -m “Your note” Push to GitHub $ git push origin <branch-name> Hypothetically, submit a pull request
81. Pushing Commits to a Pull Request Push to shared repo PR branch $ git push origin <branch-name> Push to a forked repo PR branch $ git push https://github.com/<user-name>/<repo-name> <local-branch-name>:<remote-branch-name>
82. Triaging Triaging Labels • hacktoberfest • first-timer • good first contribution • mentor available • up-for-grabs • help wanted
83. Finding Community Projects Versus Via GitHub Search
84. When You Locate a Project • Use the GitHub Contributing Checklist • Look for a CONTRIBUTING.md Let them know if you: • Find an issue you want to take • Think of a feature that you want to add
85. Documentation README.md CODE_OF_CONDUCT.md LICENSE CONTRIBUTING.md
86. Newcomer Perspective is Valuable! • Project veterans may be unable to see the project through the eyes of a beginner • Improve things for the next person • Create installation docs ◦
87. When You Get Stuck • Google • Stack Overflow • GitHub docs • Git docs • Atlassian and GitLab docs
88. Go For It! Katherine “Kati” Michel Twitter handle: @KatiMichel GitHub username: KatherineMichel Useful Resources: https://git.io/JU2AR