Added some git hints

diff --git a/trb3/CodeRepository.tex b/trb3/CodeRepository.tex
index d21f126cfe92fe8b932367f97eecbe3a3ffe515c..4f9d605ac47ed18da3f4b5c05c8b65a0c35e0568 100644 (file)
--- a/trb3/CodeRepository.tex
+++ b/trb3/CodeRepository.tex
@@ -28,6 +28,26 @@
  \item The cvs URLs are accessible with password or ssh-key only.
 \end{itemize*}
 
+\subsubsection{Some Hints for git contributors}
+Here are some (personal) hints for using git more effectively. Feel free to
+extend that list or provide useful links, but don't create a whole git
+tutorial here (this can be googled duckduckgo'ed).
+\begin{itemize*}
+\item NEVER use \verb!git push --force! or \verb!git push -f! (most
+  likely you will make everybody else angry, except you're the poor
+  one who must fix a previous forced push)
+\item Have a look at \verb!git rebase -i!. With interactive rebase,
+  you can easily reword, split and reorder your local commits before
+  pushing them, helping others to understand your changes quickly.
+\item Use \verb!git add -p! if you made a lot of changes but you want
+  to create several commits out of them (can be combined with
+  interactive rebase).
+\item Use \verb!git commit --author "My Name <your@email.com>"! if
+  you're committing from the hadaq account (or similar group
+  accounts). Then you don't need to mention your name or initials in
+  the commit message.
+\end{itemize*}
+
 \subsection{FPGA designs}
 \begin{itemize*}
  \item A list of current FPGA design files can be obtained from \\\url{http://www.editgrid.com/user/hadaq/Design_Files}