Git and Github at organizations

Slide 1

Slide 1 text

NOTICE: Propriety and Conﬁden5al This material is propriety to Shopsense. IT contains trade secrets and conﬁden5al informa5on which is sole propriety of Shopsense. This material is solely for Clients internal use. This material shall not be used, reproduced, copied, disclosed, transmiBed, in whole or in part, without the express wriBen consent of Shopsense 2013 Shopsense Retail Technologies. All rights reserved. www.shopsense.co [email protected] @ShopsenseCo © Development @ Shopsense From coding prac5ces to code management Tuesday, 13 August 13

Slide 2

Slide 2 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © Agenda 2 • Organiza5on • Code Management • Version Controlling • Release Management • Tes5ng • PaBerns • Git Internals Tuesday, 13 August 13

Slide 3

Slide 3 text

Slide 4

Slide 4 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 4 Organiza5on • Team Account on GitHub • Owners • Developers • Designers • Various Access privileges Tuesday, 13 August 13

Slide 5

Slide 5 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 5 Organiza5on • Team Account on GitHub • Owners • Developers • Designers • Various Access privileges Push, Pull & Administra5on ➜ Push, Pull ➜ Pull ➜ Tuesday, 13 August 13

Slide 6

Slide 6 text

Slide 7

Slide 7 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © master feature 7 • ONE master • Extract feature branch • feature_feature_name Code Management Tuesday, 13 August 13

Slide 8

Slide 8 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 8 • ONE master • Extract feature branch • feature_feature_name • Code Review aka Pull Request Code Management master feature pull request Tuesday, 13 August 13

Slide 9

Slide 9 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 9 Code Review • Get reviewed, whatever you are pushing • Called Pull Request on Github • Nothing should go to master without Code Review master feature pull request Tuesday, 13 August 13

Slide 10

Slide 10 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 10 Code Review • Get reviewed, whatever you are pushing • Called Pull Request on Github • Nothing should go to master without Code Review master feature pull request Why? • Two be7er than one • Maintain Hygiene • Maintain Best Prac@ces, Standards Tuesday, 13 August 13

Slide 11

Slide 11 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 11 Code Review • Get reviewed, whatever you are pushing • Called Pull Request on Github • Nothing should go to master without Code Review Why? • Two be7er than one • Maintain Hygiene • Maintain Best Prac@ces, Standards master feature pull request Why Not? • Fault ﬁnding • Revenge Tuesday, 13 August 13

Slide 12

Slide 12 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 12 Code Review • Get reviewed, whatever you are pushing • Called Pull Request on Github • Nothing should go to master without Code Review Why? • Two be7er than one • Maintain Hygiene • Maintain Best Prac@ces, Standards master feature pull request Why Not? • Fault ﬁnding • Revenge End the Pull Request with a :shipit: emoCcon Tuesday, 13 August 13

Slide 13

Slide 13 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 13 Code Review • Get reviewed, whatever you are pushing • Called Pull Request on Github • Nothing should go to master without Code Review Why? • Two be7er than one • Maintain Hygiene • Maintain Best Prac@ces, Standards master feature pull request Why Not? • Fault ﬁnding • Revenge End the Pull Request with a :shipit: emoCcon Tuesday, 13 August 13

Slide 14

Slide 14 text

Slide 15

Slide 15 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © • Major.Minor.Revision • Tags for Releasable Versions • Whenever you commit to master • Log your commits to change-‐list • git log v0.1.2..HEAD >> changelist.log Versioning Tuesday, 13 August 13

Slide 16

Slide 16 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © Automate! 16 Versioning • Major.Minor.Revision • Tags for Releasable Versions • Whenever you commit to master • Log your commits to change-‐list • git log v0.1.2..HEAD >> changelist.log Tuesday, 13 August 13

Slide 17

Slide 17 text

Slide 18

Slide 18 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 18 Release Management • Master to staging every week • Dog fooding -‐ You are the dev and you’re the QA! • When ready for produc5on, tag master to a release • GitHub Releases maps a release to a git tag Tuesday, 13 August 13

Slide 19

Slide 19 text

Slide 20

Slide 20 text

2013 Shopsense Retail Technologies. Confiden5al document, not for circula5on. All rights reserved © 20 when do .. you are working on a branch and you see something broken in master .. commit/stash changes in your current branch ‘b’, create a new branch from master ‘n’. Fix bug, raise PR. When ‘n’ is merged in master, rebase ‘b’ .. you are working on a branch ‘a’ but cannot merge it right now. But you want to work on a feature that relies on changes in branch ‘a’. .. create a branch ‘b’ from ‘a’. Once ‘a’ is merged into master, rebase ‘b’ against master. Resolve conflicts (an5cipate many of them) .. you are making some changes which you think doesn’t really need a PR. For example; indenta5on or spelling error fix .. create a PR, assign it to yourself, make a comment and close it yourself. .. you want to prototype and get feedback on your idea .. clone the repo, make branches, perfect the code, test it and submit a PR Best Practices Tuesday, 13 August 13

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 27 What is Git? .git Files Objects Refs Hooks Info Metadata Tree Blob Tree Blob Tree Blob Tuesday, 13 August 13

Slide 28

Slide 28 text

Slide 29

Slide 29 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 29 lib compute.py math calculus.py matrix.py Blob Tree Blob Blob Tree Commit How Git works? At commit Tuesday, 13 August 13

Slide 30

Slide 30 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 30 lib compute.py math calculus.py matrix.py Blob Tree Blob Blob HEAD BRANCH Tree Commit How Git works? At commit Tuesday, 13 August 13

Slide 31

Slide 31 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 31 lib compute.py math calculus.py matrix.py Blob Tree Blob Blob HEAD BRANCH Tree Commit How Git works? You make changes Tuesday, 13 August 13

Slide 32

Slide 32 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 32 Blob Tree Blob Blob Tree Commit Tree Commit Blob Tree Blob lib compute.py math calculus.py matrix.py How Git works? New commit object Tuesday, 13 August 13

Slide 33

Slide 33 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 33 Blob Tree Blob Blob Tree Commit Tree Commit HEAD BRANCH Blob Tree Blob lib compute.py math calculus.py matrix.py How Git Works? Tuesday, 13 August 13

Slide 34

Slide 34 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 34 Blob Tree Blob Blob Tree Commit Tree Commit HEAD BRANCH Blob Tree Tag Blob lib compute.py math calculus.py matrix.py How Git Works? Tuesday, 13 August 13

Slide 35

Slide 35 text

Slide 36

Slide 36 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © 36 Staging Local Git DB Working Directory REMOTE git add git commit git push origin .. git pull / fetch git checkout / merge How Git works? Local-‐Staging-‐Produc5on Tuesday, 13 August 13

Slide 37

Slide 37 text

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

Slide 46

Slide 46 text

Slide 47

Slide 47 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © References 47 • h7p://zachholman.com/talk/how-‐github-‐uses-‐github-‐to-‐build-‐github/ • h7p://git-‐scm.com/book/en/Git-‐Internals Tuesday, 13 August 13

Slide 48

Slide 48 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © Coding Style Guide 48 Python h7p://www.python.org/dev/peps/pep-‐0008/ R h7p://google-‐styleguide.googlecode.com/svn/trunk/Rguide.xml ObjecCve C h7p://google-‐styleguide.googlecode.com/svn/trunk/objcguide.xml JavaScript h7p://google-‐styleguide.googlecode.com/svn/trunk/javascriptguide.xml CPP h7p://google-‐styleguide.googlecode.com/svn/trunk/cppguide.xml C h7p://www.maultech.com/chrislo7/resources/cstyle/Peter_CStyleGuide.pdf C# / Java h7p://www.shopsense.co/wiki/index.php?@tle=User_talk:Rajat Tuesday, 13 August 13

Slide 49

Slide 49 text

2013 Shopsense Retail Technologies. Conﬁden5al document, not for circula5on. All rights reserved © Editors and IDE’s and Tools 49 Python Aptana SCM Git, GitHub Database MySQL, SQLite Database Client Sequel Pro, SQL Yogi StaCsCcs R HTML / JS / CSS Aptana C# Visual Studio ObjecCve C XCode Java Eclipse C / C++ Netbeans QT QT Editor Tuesday, 13 August 13