Downloaded 143 times
Uploaded byvisual28
Version control
This document provides an overview of version control systems, including their benefits and basic functions. Version control systems allow recording changes to files over time, allowing users to recall specific file versions. They offer advantages like backup and restoration of files, synchronization across multiple computers, and facilitating collaboration on teams. The document defines common version control terms and best practices for users.
More Related Content
Version control
- 1.
- 2. a system that recordschanges to a file over time so you can recall specific versions later.
- 3.
- 4. YOU’RE NOT TOTALLY WRONG •Clever names like: .old .bak .orig • Version Numbers: v1, v1a • Date: feb102016.doc, 20160210.doc • Store in location accessible to others
- 5.
- 6. BENEFITS OF VERSION CONTROL •Backup and restore • Sync with multiple computers • Working in a team • Safely create and test new features • Ownership / Credits / Blame
- 7.
- 8. INDUSTRY JARGON • Repository(repo): Database where files are stored • Server: The computer storing the repository • Client: The computer connecting to the repository • Working Copy: Your local directory of files • Trunk / Main: Master location for code in the repository • Head: The latest revision in the repository
- 9. BASIC ACTIONS • Add:Place a file under version control • Check in: Send local changes to the repo • Check out: Download from a repo to your working copy • Ignore: Allows files to exist in your working copy but not in the repo • Revert: Throw away your working copy and restore last revision • Update / Sync: Update your working copy to the latest revision Jargon
- 10.
- 11.
- 12. ADVANCED ACTIONS • Diff/ Change: Specific modification to a document • Branch: Duplicate copy of code used for feature development • Merge: Integrate changes from two different branches • Conflict: Inability to reconcile changes to a document • Resolve: Manual fixing of conflicted document changes • Locking: Prevents other developers from making changes Jargon
- 13. DIFF / CHANGE/ DELTA
- 14.
- 15.
- 16.
- 17.
- 18.
- 19.
- 20. CENTRALIZED VS DISTRIBUTED Repository Working Copy Workstation #1 Working Copy Workstation#2 Server Commit / Update Repository Working Copy Workstation #1 Working Copy Workstation #2 Server Push / Pull Repository Repository Commit / Update
- 21.
- 22. COMMIT RELATED CHANGES •Fixing two bugs = two separate commits • Small commits – Easier to understand – Easier to roll back – Less conflict
- 23. COMMIT / UPDATEOFTEN • Again… – Easier to understand – Easier to revert – Less chance of conflict
- 24. DO NOT COMMIT •Broken code • Something that is half done – Split large tasks into smaller chunks • Untested work
- 25.
- 26. PETER HUTTERER “A diff willtell you what changed, but only the commit message can properly tell you why.” http://who-t.blogspot.co.at/2009/12/on-commit-messages.html
- 27. COMMITS ANSWER 3 QUESTIONS •Why is it necessary? It may fix a bug, add a feature, improve performance, reliability, stability, or just be a change for the sake of correctness. • How does it address the issue? For obvious patches this part can be omitted, but it should be a high level description of what the approach was. • What effects does the patch have? (In addition to the obvious, this may include benchmarks, side effects, etc.)
- 28. GENERALLY ACCEPTED RULES • Firstline is the subject. ~50 character limit • Separate subject from body with a new line • Subject need not include a period • Use the imperative, present tense (change not changed or changes) • *Decide internally on a system and stick to
- 29. IF APPLIED, THISCOMMIT WILL ______ • Refactor subsystem X for readability • Update getting started documentation • Remove deprecated methods • Release version 1.0.0 • Merge pull request #123 from user/branch
- 30.
- 31. DESIGNERS USE VERSION CONTROL? •Not just for text files • Adobe Version Cue – http://sixrevisions.com/project-management/the-ultimate-guide-to-version- control-for-designers/ • GUI based tool • Can even diff graphics
- 32.
- 33. TOOLS & APPS- MAC Git • gityapp.com • git-tower.com • sourcetreeapp.com • gitboxapp.com • GitHub Desktop Subversion • versionsapp.com • kaleidoscopeapp.com • Cornerstone • Beyond Compare • Xcode (FileMerge)
- 34. TOOLS & APPS- WIN Git • TortoiseGit • sourcetreeapp.com • GitHub Desktop • IDE integration Subversion • TortoiseSVN • TortoiseIDiff (image diff) • IDE integration • WinMerge
- 35. CONTINUED READING • https://homes.cs.washington.edu/ ~mernst/advice/version- control.html •http://sixrevisions.com/project- management/the-ultimate-guide- to-version-control-for-designers • https://www.git-tower.com/learn • http://betterexplained.com/articles/ a-visual-guide-to-version-control • http://www.troyhunt.com/2011/05/1 0-commandments-of-good- source-control.html • http://who- t.blogspot.co.at/2009/12/on- commit-messages.html
Editor's Notes
- #14 A change (or diff, or delta) represents a specific modification to a document under version control.
- #15 A set of files under version control may be branched or forked at a point in time so that, from that time forward, two copies of those files may develop at different speeds or in different ways independently of each other.
- #16 Apply the changes from one file to another, to bring it up-to-date. For example, you can merge features from one branch into another.