1. Contributing to GitHub
Is For Everyone
Matthew Heusser
Chris Kenst
Spring OnlineTestConf
June 13, 2017
2. Introduction
Meta-Goal: Get you up and running on GitHub. Today. Serious.
Other Good Things and Side Benefits:
● Understand where configuration management comes from
● Be able to speak to a developer about branching, pipeline, merging strategy
● Have your own active GitHub account with meaningful commits tomorrow!
3. Watch and Learn
● We’re going to teach you how to do this as we go along.
● Here is what we recommend:
...
1. Watch us as we do the upcoming things
2. Reply the video, step along with us, pausing to do the things we are talking
about
...
Ready?
5. Let’s Get it Started
Pre-requisites
1. You’ll need to have git installed locally
a. For Mac users, this comes installed with Xcode. Otherwise you can download it
b. For Windows users, download and install it: https://git-scm.com/downloads
c. Set your Username and Email address within git: https://help.github.com/articles/set-up-git/
i. The Username and Email will need to match the one you used for GitHub.com
2. Install a Text Editor
a. We’ll be using Atom (also built by GitHub) but feel free to Sublime Text or one of your favorites
b. Download Atom: https://atom.io/
6. Creating our first Project
1. Go to GitHub.com and sign up for a free account
2. We'll create a repository through the Web interface
a. Starting on the login page, clicking the green "+ New Repository" button at the middle right
b. Name your repository
c. Check the option for Initialize this repository with a README
d. Click Create Repository button
e. Boom. Your repo has been created
3. Download your code
a. Click the green “Clone or download button”
b. Copy the url of your repo
c. Switch to your command line and type `git clone + <url of repo>` and hit enter
7. 4. Make an edit
a. Browse to your folder in the command line
b. Open an text editor within this repo (you can type `atom .` for mac to open Atom)
c. Go to your README.md file and add some text description. Then save.
5. Confirm our changes & commit them
a. Type `git status` (and press enter) to display a list of changes
b. Type `git add .` to add all of our changes to the index. This prepares our files to be committed
c. Type `git commit -m “description of change”` to commit the change
d. Great, now we’re ready to push our changes up to GitHub
6. PUSH your local changes
a. Type `git push origin <branch name>`
7. Confirm our changes are reflected on GitHub.com
8. Making changes to our Project with Branching
1. For each additional set of changes we’ll:
a. Create a branch,
b. make our changes,
c. commit our changes and then push them up in this new
branch.
2. Within our existing repo
a. Create a new branch `git checkout -b <branch name>`
b. This will automatically create and place us within our new
branch (not on master)
3. Same workflow as before:
a. Make an edit (see previous slide)
b. Confirm our changes and commit them
c. PUSH your local changes
9. 4. Submit a Pull Request
a. Go to the Pull Request tab at the top
b. Click the green “New pull request” button
c. Set the base fork to master and the head fork to your branch
d. Add some text to the change
e. Create the Pull Request
5. Once the Pull Request is merged, your changes will be
in!
a. Merged to Master! (aka Production)
10. Contributing to an existing project
1. Go to GitHub.com and find a project that you have some interesting in helping
2. Fork the repository
a. In the upper right corner, click Fork. This will bring a copy of the repo into your account
3. Repeat everything we’ve already done
4. When you make your Pull Request
a. Set the base fork to the original repository and the head fork to your repository / branch
5. Once the Pull Request is merged, you are in!
11. Version Control & Configuration Mgmt
The WWII Tank Problem
More than code
12. ● Checkout model
● Gave way to commit
● Gave way to push
Basic syntax:
git add file.txt
git commit file.txt
git push file.txt
What That Looks Like For Software
13. Why GitHub?
● Free public hosting of code repositories that include many tools:
● Really nice for open source code / projects
● GitHub offers a way to be techincal beyond writing code
● Learn the development workflow
14. ● GitHub is the new linkedin
○ You are making a public portfolio
of work you can actually share
○ You can follow and be followed by
fellow GitHub users
○ Star other projects for later
Your Public Portfolio
15. GitHub for more than Code
● GitHub is great for all those prior reasons
● Once you understand the Git + GitHub workflow you can do so much more
than store code!
● For example...
16. Run a Website
● Jekyll based GitHub Pages
● Free hosting & domain
17. Write a Book (or Documentation)
● Write in GitHub
● Stylize and publish with
GitBook
18. Create Lists
● Lists are great for Data, Heuristics, Checklists, and more.
● Data:
○ Images
■ Catalog of images for Testing
○ Input Field values
■ Big List of Naught Strings
■ String, Integers, etc Lists
● Many lists turn into Lists of Lists...
19. Make Notes
● Create notes to help
you remember things.
● This note contains
guidelines on how to
write exploratory
testing charters ->
20. Help! What should I add?
● Configuration files (sometimes called dotfiles) to your favorite editors,
terminals, etc.
● Code or Markup Language
○ CSS files
○ Blog Code
○ Personal Projects (like Selenium Bootcamps, etc.)
○ Classes you take where you’ve written code
● Documents
○ Lists
○ Images
○ Articles
○ GitBook
21. Filing Bugs: GitHub Issues
● Don’t want to commit changes? File a bug on a project you enjoy (and follow)
● Bug Reports are the tester’s primary work product
○ If you can write them well, you can use them as examples in your portfolio
○ More importantly you can contribute by Testing a product
● GitHub Issues is a fully featured bug tracker with:
○ Title, Summary and Comment Fields
○ Assign Issues to team members
○ Apply Labels
○ Add to Projects
○ Add to Milestones
● Exercise: Open an issue on the repo you created
○ Either report a bug or create a task
22. Projects to Contribute To
● You want to contribute now but don’t know where to start?
○ Best bet is to look around and star things you like. Then begin using them and contribute when
you find problems or can offer suggestions.
● TestingConferences.org
○ This is a simple list of software testing conferences and workshops published collaboratively
with the testing community.
● Wordpress.com Desktop App
● Babel, Node / NPM, Rails
○ Many of these projects have labels for first time submitters. Using these labels will get you
better responses from the project’s members
23. More Please
Websites & Blogs powered by GitHub Pages:
● http://olivierlacan.com/
● http://jonallured.com/
● http://testingconferences.org/
● More help creating a GitHub blog: https://pages.github.com/
Lists:
● 9 GitHub Lists for Testing
● 18 GitHub Projects for Testing
25. Final Thoughts & Comments
Questions if we ran out of time? Go to Chris’s Ask Me Anything.
Get Stuck? Ask post-conference questions on The Creative Chaos Blog or on
slack!