Skip to content

Commit

Permalink
docs(git): Add configuration section
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Feb 29, 2024
1 parent 68cb01b commit 78d053f
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/git/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
Git
===

Configuration
-------------

We recommend using:

.. code-block:: bash
git config --global init.defaultBranch main
git config --global push.autoSetupRemote true
git config --global merge.conflictstyle zdiff3
git config --global diff.algorithm histogram
git config --global diff.colorMoved default
git config --global diff.colorMovedWS allow-indentation-change
You might also like (requires installing `difftastic <https://difftastic.wilfred.me.uk/installation.html>`__):

.. code-block:: bash
git config --global diff.tool difftastic
If you sign commits, `tell Git about your signing key <https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key>`__, for example:

.. code-block:: bash
git config --global user.signingkey 3AA5C34371567BD2
git config --global commit.gpgsign true
git config --global gpg.program $(which gpg)
.. seealso::

`Popular git config options <https://jvns.ca/blog/2024/02/16/popular-git-config-options/>`__

Commit messages
---------------

Expand Down

0 comments on commit 78d053f

Please sign in to comment.