Development/Git/en: Difference between revisions

From KDE TechBase
(Updating to match new version of source page)
 
(Importing a new version from external source)
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
This is the hub page for all information about the use of Git by KDE.
This is the hub page for all information about the use of Git by KDE.


This page is a work in progress where all new Git material is being organisedMost of these sections will eventually be moved to their own pages. Feel free to add stuff.
== KDE and Git ==
 
This section provides details on using the KDE Git infrastructureThis is intended for use by KDE developers to find out how KDE uses Git and how to set up Git for use with KDE.
 
The [http://community.kde.org/Sysadmin/GitKdeOrgManual KDE Git System Administrators Manual] is a useful resource for more details on the technical implementation of the KDE Git infrastructure.


== KDE and Git ==
For more information on how the KDE Git Repositories are organized, please see the [[Getting_Started/Sources|Sources]] page or the [https://projects.kde.org/projects KDE Git Projects] page.


This section provides details on using the KDE Git infrastructure.
Please note that some KDE modules are still using SVN, for more details read the [[Getting_Started/Sources/Using_Subversion_with_KDE|Using Subversion with KDE]] page.


[http://community.kde.org/Sysadmin/GitKdeOrgManual is still the primary resource.]
=== KDE Git Configuration ===
=== KDE Git Configuration ===


How to configure Git for use with the KDE infrastructure.
How to configure Git for use with the KDE infrastructure.


Please see the [[/Configuration|Git Configuration page]].
Please see the [[Special:myLanguage/Development/Git/Configuration|Git Configuration page]].
 
=== KDE Git Policies ===
=== KDE Git Policies ===


KDE policies on Git.  More generic development policies go elsewhere.
KDE policies on Git.  More generic development policies go elsewhere.
No formal workflow policy currently exists, but a number of draft proposals have been made:
* [[/Simple Workflow/]]
* [[/Feature Branch Workflow/]]
* [[Development/Tutorials/Git/Feature Development Workflow|Feature Development Workflow]]
* [http://community.kde.org/Frameworks/Git_Workflow Git Workflow on the Community Wiki]
Other:
* The new [[Policies/Commit Policy|Commit Policy]] is being reviewed, applied to both SVN and Git.
* [[/GitHub Mirror/]] has been created and policy is in development (Sep 2015).


=== KDE Git Recipes ===
=== KDE Git Recipes ===
Line 22: Line 36:
Short recipes for using Git with the KDE infrastructure.
Short recipes for using Git with the KDE infrastructure.


Please see the [[/Recipes|Git Recipes page]].
Please see the [[Special:myLanguage/Development/Git/Recipes|Git Recipes page]].
 
=== KDE Git Tutorials ===
=== KDE Git Tutorials ===


More in-depth instructions in using Git.
More in-depth instructions in using Git.
* [[Development/Tutorials/Git/GitQuickStart|A quick step-by-step guide for getting started]]
 
* [[Development/Tutorials/Git/Create a patch|Creating a patch]]
* [[Special:myLanguage/Development/Tutorials/Git/GitQuickStart|A quick step-by-step guide for getting started]]
 
* [[Special:myLanguage/Development/Tutorials/Git/Create a patch|Creating a patch]]


Please help filling this section by
Please help filling this section by
Line 38: Line 55:


=== Official Documentation ===
=== Official Documentation ===
* [http://git-scm.com/documentation Links to git official documentation]
* [http://git-scm.com/documentation Links to git official documentation]


=== Git for SVN Users ===
=== Git for SVN Users ===
* [http://git-scm.com/course/svn.html The git-svn Crash Course]
* [http://git-scm.com/course/svn.html The git-svn Crash Course]


=== Git books ===
=== Git books ===
* [http://progit.org/book/ Pro Git] - An easy to understand book on git (CC licensed).
* [http://progit.org/book/ Pro Git] - An easy to understand book on git (CC licensed).
* [http://book.git-scm.com/ The git community book], also as a [http://book.git-scm.com/book.pdf pdf]
* [http://book.git-scm.com/ The git community book], also as a [http://book.git-scm.com/book.pdf pdf]


=== Tutorials ===
=== Tutorials ===
* [http://www-cs-students.stanford.edu/~blynn/gitmagic/ Git Magic] - A good intro to git (in several languages!)  
* [http://www-cs-students.stanford.edu/~blynn/gitmagic/ Git Magic] - A good intro to git (in several languages!)  
*[http://tom.preston-werner.com/2009/05/19/the-git-parable.html The Git Parable] - Essential reading if you want to truly understand git.
 
*[http://tom.preston-werner.com/2009/05/19/the-git-parable.html The Git Parable]
- Essential reading if you want to truly understand git.
 
* [http://www.gitcasts.com/ Git Screencasts]
* [http://www.gitcasts.com/ Git Screencasts]
* [http://try.github.io/ tryGit] A 15 minute online interactive tutorial


=== Cheat Sheets ===
=== Cheat Sheets ===
* [http://cheat.errtheblog.com/s/git Quick reference]
* [http://cheat.errtheblog.com/s/git Quick reference]
* [http://zrusin.blogspot.com/2007/09/git-cheat-sheet.html Illustrated git cheat sheet] (broken image, get it from [[Media:Zrusin-git-cheat-sheet-medium.png]])
 
* [http://zrusin.blogspot.com/2007/09/git-cheat-sheet.html Illustrated git cheat sheet]  
(broken image, get it from [[Media:Zrusin-git-cheat-sheet-medium.png]])


= Documentation Changes =
= Documentation Changes =
Line 65: Line 95:


Keep:
Keep:
* [[Development/Tutorials/Git/Basics|Basics]]
 
* [[Development/Tutorials/Git/git-svn|Git-svn]]
* [[Special:myLanguage/Development/Tutorials/Git/Basics|Basics]]
* [[Development/Tutorials/Git/kde-qt|Kde-qt]]
 
* [[Getting Started/Sources/Amarok Git Tutorial|The Amarok Git Tutorial]]
* [[Special:myLanguage/Development/Tutorials/Git/git-svn|Git-svn]]
 
* [[Special:myLanguage/Development/Tutorials/Git/kde-qt| Kde-qt]]
 
* [[Special:myLanguage/Getting Started/Sources/Amarok Git Tutorial| The Amarok Git Tutorial]]


On community.kde.org:
On community.kde.org:
* [http://community.kde.org/Sysadmin/GitKdeOrgManual Git-KDE Manual]
* [http://community.kde.org/Sysadmin/GitKdeOrgManual Git-KDE Manual]
* [http://community.kde.org/20110213_GitWorkflowAgenda Git Workflow Agenda]
* [http://community.kde.org/20110213_GitWorkflowAgenda Git Workflow Agenda]
* [http://community.kde.org/20110213_GitWorkflowAgenda/StevesIdea Git Workflow Agenda, Steve's Idea]
* [http://community.kde.org/20110213_GitWorkflowAgenda/StevesIdea Git Workflow Agenda, Steve's Idea]
On techbase.kde.org:
On techbase.kde.org:
* [[Getting Started|Getting Started]]
 
* [[Getting Started/Build/KDE4|Build KDE 4]]
* [[Special:myLanguage/Getting Started|Getting Started]]
* [[Getting Started/Build/KDE4.x|Build KDE 4.x]]
 
* [[Getting Started/Build/KDE4/Prerequisites|Prerequisites]]
* [[Special:myLanguage/Getting Started/Build/KDE4/Prerequisites|Prerequisites]]
* [[Getting Started/Build/KDE4/Windows/subversion|Subversion on Windows]]
 
* [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increase Productivity with Scripts]]
* [[Special:myLanguage/Getting Started/Build/KDE4/Windows/subversion|Subversion on Windows]]
* [[Getting_Started/Build/kdesrc-build|Kdesrc-build]]
 
* [[Getting Started/Sources/Anonymous SVN|Anonymous SVN]]
* [[Special:myLanguage/Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increase Productivity with Scripts]]
* [[Getting_Started/Sources/Using_Subversion_with_KDE|Subversion with KDE]]
 
* [[Getting_Started/Using_an_IDE_with_KDE4|Using an IDE with KDE 4]]
* [[Special:myLanguage/Getting_Started/Build/kdesrc-build|Kdesrc-build]]
* [[Policies/SVN_Commit_Policy|SVN Commit Policy]]
 
* [[Policies/SVN_Guidelines|SVN Guidelines]]
* [[Special:myLanguage/Getting Started/Sources/Anonymous SVN|Anonymous SVN]]
* [[Development/Tools|Development Tools]]
 
* [[Development/Tutorials/Git/Recipes|Git Recipes]]
* [[Special:myLanguage/Getting_Started/Sources/Using_Subversion_with_KDE|Subversion with KDE]]
* [[Development/Tutorials/Git/decoding-git|Decoding Git]]
 
* [[Projects/rekonq/Git_with_rekonq_HowTo|Git with Rekonq How-to]]
* [[Special:myLanguage/Getting_Started/Using_an_IDE_with_KDE4|Using an IDE with KDE 4]]
* [[Projects/Related/Subversion|Subversion]]
 
* [[Projects/MovetoGit|Move to Git]]
* [[Special:myLanguage/Policies/SVN_Commit_Policy|SVN Commit Policy]]
* [[Projects/MoveToGit/StepsToMove|Steps to Move]]
 
* [[Contribute/Get a SVN Account|Get a SVN Account]]
* [[Special:myLanguage/Policies/SVN_Guidelines|SVN Guidelines]]
* [[Contribute/First Steps with your KDE SVN Account|First Steps with your KDE SVN Account]]
 
* [[Special:myLanguage/Development/Tools|Development Tools]]
 
* [[Special:myLanguage/Development/Tutorials/Git/Recipes|Git Recipes]]
 
* [[Special:myLanguage/Development/Tutorials/Git/decoding-git|Decoding Git]]
 
* [[Special:myLanguage/Projects/rekonq/Git_with_rekonq_HowTo|Git with Rekonq How-to]]
 
* [[Special:myLanguage/Projects/Related/Subversion|Subversion]]
 
* [[Special:myLanguage/Projects/MovetoGit|Move to Git]]
 
* [[Special:myLanguage/Projects/MoveToGit/StepsToMove|Steps to Move]]
 
* [[Special:myLanguage/Contribute/Get a SVN Account|Get a SVN Account]]
 
* [[Special:myLanguage/Contribute/First Steps with your KDE SVN Account|First Steps with your KDE SVN Account]]


There are also numerous other pages referring to "the KDE SVN/subversion repositories" which should be replaced with the generic "KDE code repositories".
There are also numerous other pages referring to "the KDE SVN/subversion repositories" which should be replaced with the generic "KDE code repositories".
Line 102: Line 157:


=== New Page Structure ===
=== New Page Structure ===
* [[Special:myLanguage/Getting_Started|Getting Started]]
* [[Special:myLanguage/Getting_Started|Getting Started]]
* [[Special:myLanguage/Getting_Started/Build|Getting_Started/Build]]
* [[Special:myLanguage/Getting_Started/Build|Getting_Started/Build]]
* [[Special:myLanguage/Getting_Started/Build/Environment|Getting_Started/Build/Environment]]
* [[Special:myLanguage/Getting_Started/Build/Environment|Getting_Started/Build/Environment]]
* [[Special:myLanguage/Getting_Started/Build/Requirements|Getting_Started/Build/Requirements]]
* [[Special:myLanguage/Getting_Started/Build/Requirements|Getting_Started/Build/Requirements]]
* [[Special:myLanguage/Getting_Started/Build/Qt|Getting_Started/Build/Q]]
* [[Special:myLanguage/Getting_Started/Build/Qt|Getting_Started/Build/Q]]
* [[Special:myLanguage/Getting_Started/Build/KdeSupport|Getting_Started/Build/KdeSupport]]
* [[Special:myLanguage/Getting_Started/Build/KdeSupport|Getting_Started/Build/KdeSupport]]
* [[Special:myLanguage/Getting_Started/Build/Windows|Getting_Started/Build/Windows]]
* [[Special:myLanguage/Getting_Started/Build/Windows|Getting_Started/Build/Windows]]
* [[Special:myLanguage/Getting_Started/Build/Mac_OS_X|Getting_Started/Build/Mac_OS_X]]
* [[Special:myLanguage/Getting_Started/Build/Mac_OS_X|Getting_Started/Build/Mac_OS_X]]
* [[Special:myLanguage/Getting_Started/Run/Shell|Getting_Started/Run/Shell]]
* [[Special:myLanguage/Getting_Started/Run/Shell|Getting_Started/Run/Shell]]
* [[Special:myLanguage/Getting_Started/Run/Nested_Session|Getting_Started/Run/Nested_Session]]
* [[Special:myLanguage/Getting_Started/Run/Nested_Session|Getting_Started/Run/Nested_Session]]
* [[Special:myLanguage/Getting_Started/Run/Full_Session|Getting_Started/Run/Full_Session>]]
* [[Special:myLanguage/Getting_Started/Run/Full_Session|Getting_Started/Run/Full_Session>]]

Latest revision as of 10:25, 11 March 2016

This is the hub page for all information about the use of Git by KDE.

KDE and Git

This section provides details on using the KDE Git infrastructure. This is intended for use by KDE developers to find out how KDE uses Git and how to set up Git for use with KDE.

The KDE Git System Administrators Manual is a useful resource for more details on the technical implementation of the KDE Git infrastructure.

For more information on how the KDE Git Repositories are organized, please see the Sources page or the KDE Git Projects page.

Please note that some KDE modules are still using SVN, for more details read the Using Subversion with KDE page.

KDE Git Configuration

How to configure Git for use with the KDE infrastructure.

Please see the Git Configuration page.

KDE Git Policies

KDE policies on Git. More generic development policies go elsewhere.

No formal workflow policy currently exists, but a number of draft proposals have been made:

Other:

  • The new Commit Policy is being reviewed, applied to both SVN and Git.
  • GitHub Mirror has been created and policy is in development (Sep 2015).

KDE Git Recipes

Short recipes for using Git with the KDE infrastructure.

Please see the Git Recipes page.

KDE Git Tutorials

More in-depth instructions in using Git.

Please help filling this section by

  • checking the links at the bottom of the page and see which still have valid content
  • write tutorials yourself

External Git Resources

Links to useful external sites about Git

Official Documentation

Git for SVN Users

Git books

  • Pro Git - An easy to understand book on git (CC licensed).

Tutorials

  • Git Magic - A good intro to git (in several languages!)

- Essential reading if you want to truly understand git.

  • tryGit A 15 minute online interactive tutorial

Cheat Sheets

(broken image, get it from Media:Zrusin-git-cheat-sheet-medium.png)

Documentation Changes

KDE Documentation Review

Existing Pages For Review

Existing KDE pages about Git, SVN, and/or buildinga KDE that need to be revised. When revising pages try to split the generic development and revision control policies separate from Git specific stuff. Do not refer to "the KDE Git Repository" but instead the "KDE Code Repository". Lots of small simple pages that are less daunting to newbies and can be linked to from multiple locations are preferred to massive walls of text.

Keep:

On community.kde.org:

On techbase.kde.org:

There are also numerous other pages referring to "the KDE SVN/subversion repositories" which should be replaced with the generic "KDE code repositories".

There are also numerous translated pages which will need to be updated once the original pages are completed.

New Page Structure