X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;ds=sidebyside;f=pep-git.txt;h=d995d2456fe367ceaa1d0fa0a8081274497d2e2c;hb=2081cc6efd1cc32ab084713a7e2d30d435f93131;hp=595cea4b2851df1e0c401beb83d1bd233b2407f7;hpb=77eb8366d7bf1060ebac851f35a8f2d05fd3f7d1;p=git-wiki.git
diff --git a/pep-git.txt b/pep-git.txt
index 595cea4..d995d24 100644
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -23,6 +23,7 @@ Python development from Mercurial to git.
The author of the PEP doesn't currently plan to write a Process PEP on
migration from Mercurial to git.
+
Documentation
=============
@@ -64,6 +65,77 @@ Offline documentation
Git has builtin help: run ``git help TOPIC``. For example, run
``git help git`` or ``git help help``.
+
+Quick start
+===========
+
+Download and installation
+-------------------------
+
+Unix users: download and install using your package manager.
+
+Microsoft Windows: download `git-for-windows
+`_.
+
+MacOS X: use git installed with `XCode
+`_ or download
+`git-osx-installer
+`_.
+
+Initial configuration
+---------------------
+
+This simple code is often appears in documentation, but it is
+important so let repeat it here::
+
+ $ git config --global user.name "User Name"
+ $ git config --global user.email user.name@example.org
+
+
+Examples in this PEP
+====================
+
+Examples of git commands in this PEP use the following approach. It is
+supposed that you, the user, works with a local repository named
+``python`` that has an upstream remote repo named ``origin``. Your
+local repo has two branches ``v1`` and ``v2``. Usually the currently
+checked out branch is ``v2``.
+
+
+Commit editing and caveats
+==========================
+
+A warning not to edit published (pushed) commits also appears in
+documentation but it's also repeated here as it's very important.
+
+It is possible to recover from forced push but it's PITA for the
+entire team. Please avoid it.
+
+To see what commits have not been published yet see the head of the
+remote branch::
+
+ $ git log origin/v2..
+
+For every branch that has an upstream remote branch git maintains an
+alias @{upstream} (short version @{u})::
+
+ $ git log @{u}..
+ $ git log v1@{u}..v1
+
+To see the status of all branches::
+
+ $ git branch -avv
+
+Read `how to recover from upstream rebase
+`_.
+It is in ``git help rebase``.
+
+On the other hand don't be too afraid about commit editing. You can
+safely edit commits that hasn't been pushed yet. You can even push
+commits to your own (backup) repo, edit them later and force-push
+edited commits to replace what has already been pushed.
+
+
References
==========