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

Transcript

1. Get a Jumpstart on Collaboration and Code Review in GitHub By Katherine “Kati” Michel
2. Welcome!
3. About Me • DjangoCon US Website Chair • DEFNA (Django Events Foundation North America) Board Member • DjangoCon Europe Website Committee Member • Project Manager • Web Designer and Developer Twitter: @KatiMichel GitHub: KatherineMichel
4. Goal I want to teach you a process that will get you started collaborating and doing code review as quickly as possible
5. I Don’t Want You to Be Like Me!
6. Understanding the Process and Hands On Practice
7. Resources
8. Announcing TacoFancy!
9. The One Sentence That Motivated Me to Start Using GitHub
10. My First Pull Request
11. DjangoCon US Website as an Example Project DjangoCon US Website Homepage DjangoCon US Website Repo
12. What are Git and GitHub? GitHub is a website built on the version control software Git. GitHub Website Git Command Line
13. Social Network Make a User Profile Follow People Follow Activity in Newsfeed Find Interesting Projects
14. Repositories GitHub users work on code together DjangoCon US Organization Account Repo List
15. Repositories GitHub users work on code together DjangoCon US Organization Account Repo List
16. Repositories GitHub users work on code together DjangoCon US Organization Account Repo List DjangoCon US Website Repo
17. Local Dev Environment
18. Local Dev Environment $ git clone https://github.com/KatherineMichel/2017.djangocon.us
19. Local Dev Environment $ git clone https://github.com/KatherineMichel/2017.djangocon.us
20. Collaboration and Code Review Best Practice Workflow You need to switch between multiple tasks: • Keep codebase up-to-date • Create one or more features • Do code review
21. Working on a File in GitHub File on GitHub (README) Editing File Click pencil icon Edit Commit Info Save
22. Branches Master Branch
23. Branches Master Branch Feature Branch
24. Branches Master Branch Feature Branch Feature Branch
25. Branches Master Branch Feature Branch Feature Branch Feature Branch
26. Branches Master Branch Feature Branch Pull Request Branch Feature Branch Feature Branch
27. How to Create a Branch File on GitHub (README) Editing File Click pencil icon Edit Commit Info Save
28. How to Create a Branch New branch and name File on GitHub (README) Editing File
29. Overview • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, and submit a pull request • Review the two different types of pull request branches as a maintainer • Additional workflow and command info • People, communication, documentation • Recommendations • Simulation exercise
30. Section 1 • Determine which collaboration approach to use
31. The Two Collaborative Development Models • “Shared Repository” Model • “Fork and Pull” Model The two different models typically correspond to the two different account types and which model you use depends on whether you have write permission to the repo
32. Two Types of Accounts Organization Account User Account
33. Write Permission When a user has write permission to a repo, it means they can make changes directly inside of the repo
34. 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
35. Why We Need Write Permission DjangoCon US Website DjangoCon US Website Repo
36. Write Permission and Collaboration Examples Shared Repository DjangoCon US Website Repo Write Permission: Maintainers
37. 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
38. 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
39. 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
40. Forked Repo User Account www.github.com/KatherineMichel
41. Forked Repo User Account www.github.com/KatherineMichel
42. Forked Repo User Account Forked Repo www.github.com/KatherineMichel/2017.djangocon.us
43. Interesting Thing #1: Opposites
44. • Organization account owners can create teams and permissions across multiple repos • Otherwise, the repo “Shared Repository” settings are almost exactly the same Interesting Thing #2: User Account Shared Repo Disadvantage
45. Interesting Thing #3: Write Permission Examples • Organization account maintainer • User account owner(sources and forks) • User account collaborator
46. Interesting Thing #4: Inactive Pull Requests
47. Section 2 • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, 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. Section 3 • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, and submit a pull request • Review the two different types of pull request branches 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 Options Do no run code locally Run code locally Click merge Make change in browser then click merge
77. Pull Request Review Options Do no run code locally Run code locally Click merge Make change in browser then click merge No change needed, go back to browser and click merge Ask pull request author to make change You push change to pull request, then click merge You update and merge locally, push to GitHub
78. Pull Request Branches DjangoCon US Website Repo Fork Write permission granted to pull request as maintainers local branches remote origin updates pull request branch git fetch origin <remote>/<branch> .git folder git pull <url> <branch> pull request branch
79. Pull Request Review Shared Repo Branch Forked Repo Branch
80. Merge Pull Request Locally and Push to Master Branch
81. Tidy Up
82. Advanced Topics • Rebase • Interactive rebase • Squashing • Merge Conflicts • Aliases • Fetch individual pull request branches
83. Section 4 • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, and submit a pull request • Review the two different types of pull request branches as a maintainer • Additional workflow and command info
84. Practical Commands
85. GitHub Flow Live Production Site Pull Requests Master Branch
86. Another Workflow Master Branch Live Production Site Pull Requests Staging Site Develop Branch
87. Learn More About Workflow • GitHub Flow (basically, what we’ve been using) • A Successful Git Branching Model (more advanced) • A Successful Git Branching Model Considered Harmful (alternative view) • SemVer • See also: Atlassian and GitLab docs
88. Section 5 • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, and submit a pull request • Review the two different types of pull request branches as a maintainer • Additional workflow and command info • People, communication, documentation
89. Getting to 10x Results Important non-coding leadership skills • Mentor/teacher • Communicator/collaborator • Keeping docs up to date
90. Communication Strategy
91. Documentation README.md CODE_OF_CONDUCT.md LICENSE CONTRIBUTING.md
92. Templates
93. Communication Forums • Wikis • GitHub Pages/Jekyll • Gists
94. Section 6 • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, and submit a pull request • Review the two different types of pull request branches as a maintainer • Additional workflow and command info • People, communication, documentation • Recommendations
95. Code Safety
96. Additional Safety Considerations • Back up the repo • Enable required reviews of pull requests • Use status checks (external) • Revert pull requests, if needed • Worst case scenario: How to recover deleted branch • Sensitive data warning
97. Productivity Tips • Password caching • Closing issues via commit messages • Saved replies • Link to specific line numbers on GitHub
98. Triaging Triaging Labels • help wanted • first-timer • good first contribution • mentor available • up-for-grabs
99. Sandboxing Submit pull requests to yourself then review them
100. Debunking Myths • Myth: The repos look perfect. • Myth: The people working on GitHub projects must all be experts; I probably don’t fit in here. • Myth: GitHub users seem to know exactly what to do • Myth: This is all about code • Myth: I don’t want to break something
101. Go For It! Contribute to the DjangoCon US website next year! We have a diverse group of contributors of all skill levels and we are always looking for more contributors. Let us know if you are interested.
102. Section 7 • Determine which collaboration approach to use • Clone a repo into our local development environment, create a feature branch, make a change, push the branch to the GitHub repo, and submit a pull request • Review the two different types of pull request branches as a maintainer • Additional workflow and command info • People, communication, documentation • Recommendations • Simulation Exercise
103. Simulation Exercise
104. 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
105. Getting Help • Help via Git, GitHub Help and Guides • Help via command line (exit by typing “q”) • Help via GitHub Keyboard Shortcuts (type "?")
106. Thank You! Katherine “Kati” Michel Twitter handle: @KatiMichel GitHub username: KatherineMichel Useful Resources: https://git.io/v5kpy