git, github and open source

Git, Github and Open Source

About Me

2

• Lorna Jane Mitchell

• Consultant, author, speaker

• Github: http://github.com/lornajane

• Twitter: @lornajane

• Web: http://lornajane.net

• Project lead of joind.in , open source project

Github

3

"We make it easier to collaborate with others and share your projects withthe universe"

• Github is a hosted source control solution, based on git.

• Used by open source projects, personal projects

• Paid-for offerings for non-public code

There are other ways to do git, open source, and probably everythingmentioned here ...

Centralised Version Control

4

The overall ecosystem with git looks different because instead of this:

repo

checkout checkoutcheckout

Distributed Version Control

5

Things look like this:

repo

repo reporepo repo

Distributed Version Control

6

Or rather:

repo

repo

repo

repo

repo

Code on GitHub

Get a Repo

8

• Find the project

• Fork the project

• Clone your repo

Fork the Project

9https://github.com/joindin/joind.in

Clone your Repo

10

git clone git@github.com:username/joindin.git

Git: Many Repos

11

GitHub

your-user/joind.in

development

joindin/joind.in

clone

fork

Working with Git

Git Overview

13

A few key commands you will need:

• git log and git show

• git status and git diff

• git add

• git commit

• git pull and git push

• reverting changes

Then we’ll talk about branching

Git Log

14

Git automatically sends the output to a pager like less

commit 76916fed387d9161d48b0f1e592685c183e4757cAuthor: Lorna Mitchell <lorna@lornajane.net>Date: Wed Mar 14 21:06:24 2012 +0000

adding the actual announcement wording to the banner

commit 3fdc9f6b9795ed6a3a02465817bfebb8f77ca34eAuthor: Kim Rowan <rowan02@unknown-00-25-00-44-3a-04.h ome>Date: Tue Mar 13 12:58:48 2012 +0000

Added info block to main page announcing php|arch Impact Awa rd nomination

commit dc5777199aa2bb822b498ec1dea99f3e89ee90e0Author: Lorna Mitchell <lorna@lornajane.net>Date: Sun Mar 11 21:03:13 2012 +0000

removed some unused files

Git Log

15

There are some alternative views, this is git log -graph -oneline

* 76916fe adding the actual announcement wording to the banne r

* 3fdc9f6 Added info block to main page announcing php|arch Im pact Award

* dc57771 removed some unused files

* aa502ec straightening out a problem with API metadata not sh owing up

* 6719b8a GH #473: Refactored ternary to if

* d6a69d7 Merge branch 'joindin-167'|\| * b7effc5 JOINDIN-167: Facebook users without username (thi s is possible

* | 6af9450 JOINDIN-167: reverted removal of facebook login

* | 6249401 Merge branch 'master' of https://github.com/joi ndin/joind|\ \| |/|/|| * 16b31d3 Merge remote-tracking branch 'lornajane/no-face book'| |\| | * 36ee9ea removing facebook login functionality - hopefully temporarily| * | f4a2a73 removing references to the gravatar cache; these a re served| |/| * 83d6c04 Prevented forwarding on to anywhere except this sit e after| * d411358 Merge remote-tracking branch 'mvriel/JOINDIN-16 1_2'

Git Status

16

Shows you what you have changed, and what will be in your next commit(these are two different things)

After editing a couple of files:

# On branch impact-banner# Changes not staged for commit:# (use "git add <file>..." to update what will be committed)# (use "git checkout -- <file>..." to discard changes in work ing directory## modified: src/.htaccess# modified: src/system/application/views/main/index.p hp#no changes added to commit (use "git add" and/or "git commit - a")

To include changes in a commit, we need to stage them first usingmonogit add

Git Add

17

git add src/system/application/views/main/index.php

git status again

# On branch impact-banner# Changes to be committed:# (use "git reset HEAD <file>..." to unstage)## modified: src/system/application/views/main/index.p hp## Changes not staged for commit:# (use "git add <file>..." to update what will be committed)# (use "git checkout -- <file>..." to discard changes in work ing directory## modified: src/.htaccess#

Git Commit

18

git commit -m ’meaningful commit message’

• Without the -m, git will open your default text editor to add a message

• You can also supply a list of files to include in the commit

• Use git add -interactive to stage sections of files

Undoing Changes

19

To undo changes that you haven’t staged yet:

git checkout -- path/to/file

If you have staged the changes, you can still undo them:

git resetgit reset --hard

Reset will unstage the changes; the hard reset puts everything back to themost recent commit

Managing the Multiple Repositories

Stay in Sync

21

Pull the changes from upstream into your local repo

GitHub

your-user/joind.in

development

changes upstream

pull

git pull upstream master

Stay in Sync

22

The changes are now in your local repo, push them to github:

GitHub

your-user/joind.in

changes locally

changes upstream

push

git push

Branching in Git

23

What you need to know:

• Branching (and merging!) are fast and painless

Branching in Git

23

What you need to know:

• Branching (and merging!) are fast and painless

• Branches are private by default

Branching in Git

23

What you need to know:

• Branching (and merging!) are fast and painless

• Branches are private by default

• Branches are in the repo, they are not copies

• no updating vhosts

• only one directory with code in

Git Branching Commands

24

Create a new branch:

git checkout -b new-branch-name

Switch to an existing branch

git checkout branchname

List branches in this repo

git branch

Branches are local by default, they don’t synchronise to other repositoriesunless asked

Best Practice in Branching

25

Git doesn’t dictate a process, so usually each project does. Commonfeatures:

• Branch for features

• Branch for fixes

• Branch for experiments

Best Practice in Branching

25

Git doesn’t dictate a process, so usually each project does. Commonfeatures:

• Branch for features

• Branch for fixes

• Branch for experiments

• Basically: branch!

By keeping changes in branches, they are very easy to merge to anotherrepo or branch

Sharing Changes

26

Your changes are in your local branch - how do they get into a mainproject?

GitHub

your-user/joind.in

local feature

joindin/joind.in

Sharing Changes

27

git push origin new-branch-name

GitHub

feature at origin

local feature

joindin/joind.in

push

Sharing Changes

28

To offer changes upstream, make a pull request

GitHub

feature at origin

local feature

joindin/joind.in

pull request

Making a Pull Request

29

Make the pull request on GitHub

Explain what you have changed, and why. Keep changes atomic.

Open Source Contributions

30

After that:

• Your pull request appears on the project’s list

• http://github.com/joindin/joind.in/pulls

• Hopefully it gets merged

• You get bragging rights :)

• https://github.com/joindin/joind.in/contributors

Where to Begin with Open Source

31

How to get involved: (warning, contains bias!)

• Check for introductory docs

• http://joind.in/about

Where to Begin with Open Source

31

How to get involved: (warning, contains bias!)

• Check for introductory docs

• http://joind.in/about

• Get code and set up the project

• usually, fork the repo and read the README

Where to Begin with Open Source

31

How to get involved: (warning, contains bias!)

• Check for introductory docs

• http://joind.in/about

• Get code and set up the project

• usually, fork the repo and read the README

• Find the bug tracker, and pick something

• http://joindin.jira.com

Where to Begin with Open Source

31

How to get involved: (warning, contains bias!)

• Check for introductory docs

• http://joind.in/about

• Get code and set up the project

• usually, fork the repo and read the README

• Find the bug tracker, and pick something

• http://joindin.jira.com

• Talk to the other people in the project

• #joind.in on freenode

Where to Begin with Open Source

31

How to get involved: (warning, contains bias!)

• Check for introductory docs

• http://joind.in/about

• Get code and set up the project

• usually, fork the repo and read the README

• Find the bug tracker, and pick something

• http://joindin.jira.com

• Talk to the other people in the project

• #joind.in on freenode

• Share and enjoy

Questions?

Thanks!

33

• Slides will be on slideshare

• Github: http://github.com/lornajane

• Twitter: @lornajane

• Web: http://lornajane.net

PHPNW - 3rd April, Derick Rethans on MongoDB. Rain Bar, Manchester.