Development/Git: Difference between revisions

    From KDE TechBase
    (Improve links, link to GitHub Mirror)
    (122 intermediate revisions by 10 users not shown)
    Line 1: Line 1:
    <languages />
    <translate>
    <!--T:1-->
    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, feel free to add stuff.
    == KDE and Git == <!--T:3-->


    =Existing Pages=
    <!--T:4-->
    Existing KDE pages about Git and/or building KDE that need to be revised.
    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.


    <!--T:5-->
    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.
    <!--T:91-->
    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.
    <!--T:92-->
    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.
    === KDE Git Configuration === <!--T:6-->
    <!--T:7-->
    How to configure Git for use with the KDE infrastructure.
    <!--T:8-->
    Please see the [[Special:myLanguage/Development/Git/Configuration|Git Configuration page]].
    === KDE Git Policies === <!--T:10-->
    <!--T:11-->
    KDE policies on Git.  More generic development policies go elsewhere.
    <!--T:93-->
    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]
    <!--T:94-->
    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 === <!--T:12-->
    <!--T:13-->
    Short recipes for using Git with the KDE infrastructure.
    <!--T:14-->
    Please see the [[Special:myLanguage/Development/Git/Recipes|Git Recipes page]].
    === KDE Git Tutorials === <!--T:16-->
    <!--T:17-->
    More in-depth instructions in using Git.
    <!--T:18-->
    * [[Special:myLanguage/Development/Tutorials/Git/GitQuickStart|A quick step-by-step guide for getting started]]
    <!--T:19-->
    * [[Special:myLanguage/Development/Tutorials/Git/Create a patch|Creating a patch]]
    <!--T:20-->
    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 == <!--T:21-->
    <!--T:22-->
    Links to useful external sites about Git
    === Official Documentation === <!--T:23-->
    <!--T:24-->
    * [http://git-scm.com/documentation Links to git official documentation]
    === Git for SVN Users === <!--T:25-->
    <!--T:26-->
    * [http://git-scm.com/course/svn.html The git-svn Crash Course]
    === Git books === <!--T:27-->
    <!--T:28-->
    * [http://progit.org/book/ Pro Git] - An easy to understand book on git (CC licensed).
    <!--T:30-->
    * [http://book.git-scm.com/ The git community book], also as a [http://book.git-scm.com/book.pdf pdf]
    === Tutorials === <!--T:32-->
    <!--T:33-->
    * [http://www-cs-students.stanford.edu/~blynn/gitmagic/ Git Magic] - A good intro to git (in several languages!)
    <!--T:35-->
    *[http://tom.preston-werner.com/2009/05/19/the-git-parable.html The Git Parable]
    - Essential reading if you want to truly understand git.
    <!--T:37-->
    * [http://www.gitcasts.com/ Git Screencasts]
    * [http://try.github.io/ tryGit] A 15 minute online interactive tutorial
    === Cheat Sheets === <!--T:38-->
    <!--T:39-->
    * [http://cheat.errtheblog.com/s/git Quick reference]
    <!--T:40-->
    * [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 = <!--T:42-->
    == KDE Documentation Review == <!--T:43-->
    === Existing Pages For Review === <!--T:44-->
    <!--T:45-->
    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.
    <!--T:46-->
    Keep:
    <!--T:47-->
    * [[Special:myLanguage/Development/Tutorials/Git/Basics|Basics]]
    <!--T:48-->
    * [[Special:myLanguage/Development/Tutorials/Git/git-svn|Git-svn]]
    <!--T:49-->
    * [[Special:myLanguage/Development/Tutorials/Git/kde-qt| Kde-qt]]
    <!--T:50-->
    * [[Special:myLanguage/Getting Started/Sources/Amarok Git Tutorial| The Amarok Git Tutorial]]
    <!--T:51-->
    On community.kde.org:
    On community.kde.org:
    * http://community.kde.org/Sysadmin/GitKdeOrgManual
    * http://community.kde.org/20110213_GitWorkflowAgenda
    * http://community.kde.org/20110213_GitWorkflowAgenda/StevesIdea


    <!--T:52-->
    * [http://community.kde.org/Sysadmin/GitKdeOrgManual Git-KDE Manual]
    <!--T:53-->
    * [http://community.kde.org/20110213_GitWorkflowAgenda Git Workflow Agenda]
    <!--T:54-->
    * [http://community.kde.org/20110213_GitWorkflowAgenda/StevesIdea Git Workflow Agenda, Steve's Idea]
    <!--T:55-->
    On techbase.kde.org:
    On techbase.kde.org:
    * [Getting Started]
    * [Getting Started/Sources/Amarok Git Tutorial]
    * [Policies/SVN_Commit_Policy]
    * [Development/Tutorials/Git]
    * [Development/Tutorials/Git/BestPractices]
    * [Development/Tutorials/Git/Intermediate]
    * [Development/Tutorials/Git/Recipes]
    * [Development/Tutorials/Git/Create a patch]
    * [Development/Tutorials/Git/git-svn]
    * [Development/Tutorials/Git/Basics]
    * [Development/Tutorials/Git/KdeOnGit]
    * [Development/Tutorials/Git/kde-qt]
    * [Development/Tutorials/Git/Pushing]
    * [Development/Tutorials/Git/decoding-git]
    * [Projects/rekonq/Git]


    =External Git Resources=
    <!--T:56-->
    Links to useful external sites about Git
    * [[Special:myLanguage/Getting Started|Getting Started]]
     
    <!--T:59-->
    * [[Special:myLanguage/Getting Started/Build/KDE4/Prerequisites|Prerequisites]]
     
    <!--T:60-->
    * [[Special:myLanguage/Getting Started/Build/KDE4/Windows/subversion|Subversion on Windows]]
     
    <!--T:61-->
    * [[Special:myLanguage/Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increase Productivity with Scripts]]
     
    <!--T:62-->
    * [[Special:myLanguage/Getting_Started/Build/kdesrc-build|Kdesrc-build]]
     
    <!--T:63-->
    * [[Special:myLanguage/Getting Started/Sources/Anonymous SVN|Anonymous SVN]]
     
    <!--T:64-->
    * [[Special:myLanguage/Getting_Started/Sources/Using_Subversion_with_KDE|Subversion with KDE]]
     
    <!--T:65-->
    * [[Special:myLanguage/Getting_Started/Using_an_IDE_with_KDE4|Using an IDE with KDE 4]]
     
    <!--T:66-->
    * [[Special:myLanguage/Policies/SVN_Commit_Policy|SVN Commit Policy]]
     
    <!--T:67-->
    * [[Special:myLanguage/Policies/SVN_Guidelines|SVN Guidelines]]
     
    <!--T:68-->
    * [[Special:myLanguage/Development/Tools|Development Tools]]
     
    <!--T:69-->
    * [[Special:myLanguage/Development/Tutorials/Git/Recipes|Git Recipes]]
     
    <!--T:70-->
    * [[Special:myLanguage/Development/Tutorials/Git/decoding-git|Decoding Git]]
     
    <!--T:71-->
    * [[Special:myLanguage/Projects/rekonq/Git_with_rekonq_HowTo|Git with Rekonq How-to]]
     
    <!--T:72-->
    * [[Special:myLanguage/Projects/Related/Subversion|Subversion]]
     
    <!--T:73-->
    * [[Special:myLanguage/Projects/MovetoGit|Move to Git]]
     
    <!--T:74-->
    * [[Special:myLanguage/Projects/MoveToGit/StepsToMove|Steps to Move]]
     
    <!--T:75-->
    * [[Special:myLanguage/Contribute/Get a SVN Account|Get a SVN Account]]
     
    <!--T:76-->
    * [[Special:myLanguage/Contribute/First Steps with your KDE SVN Account|First Steps with your KDE SVN Account]]
     
    <!--T:77-->
    There are also numerous other pages referring to "the KDE SVN/subversion repositories" which should be replaced with the generic "KDE code repositories".
     
    <!--T:78-->
    There are also numerous translated pages which will need to be updated once the original pages are completed.
     
    === New Page Structure === <!--T:79-->
     
    <!--T:80-->
    * [[Special:myLanguage/Getting_Started|Getting Started]]
     
    <!--T:81-->
    * [[Special:myLanguage/Getting_Started/Build|Getting_Started/Build]]
     
    <!--T:82-->
    * [[Special:myLanguage/Getting_Started/Build/Environment|Getting_Started/Build/Environment]]
     
    <!--T:83-->
    * [[Special:myLanguage/Getting_Started/Build/Requirements|Getting_Started/Build/Requirements]]
     
    <!--T:84-->
    * [[Special:myLanguage/Getting_Started/Build/Qt|Getting_Started/Build/Q]]
     
    <!--T:85-->
    * [[Special:myLanguage/Getting_Started/Build/KdeSupport|Getting_Started/Build/KdeSupport]]
     
    <!--T:86-->
    * [[Special:myLanguage/Getting_Started/Build/Windows|Getting_Started/Build/Windows]]
     
    <!--T:87-->
    * [[Special:myLanguage/Getting_Started/Build/Mac_OS_X|Getting_Started/Build/Mac_OS_X]]


    =Git Configuration=
    <!--T:88-->
    How to set up Git for use in KDE.
    * [[Special:myLanguage/Getting_Started/Run/Shell|Getting_Started/Run/Shell]]


    =Git Recipes=
    <!--T:89-->
    Brief recipes for common use cases.
    * [[Special:myLanguage/Getting_Started/Run/Nested_Session|Getting_Started/Run/Nested_Session]]


    =Git Tutorials=
    <!--T:90-->
    More in-depth instructions in using Git
    * [[Special:myLanguage/Getting_Started/Run/Full_Session|Getting_Started/Run/Full_Session>]]
    </translate>

    Revision as of 19:15, 23 September 2015

    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