# [quagga-dev 12187] [PATCH 1/2] HACKING: COMMIT MESSAGE should give author/copyright details + required reading

Paul Jakma paul at jakma.org
Mon Apr 27 17:49:53 BST 2015

* HACKING.tex: (COMMIT MESSAGES) It's pretty critical that commit messages
give all the detail required to figure out what authorship/copyright claims
might come into play.
to when they contribute. It's fairly obvious, common sense stuff. Spell it
out though.
Note that COMMIT MESSAGES are also required reading.
(Cover page) Draw attention to REQUIRED READING.

Acked-by: Vincent Jardin <vincent.jardin at 6wind.com>
---
HACKING.tex | 40 +++++++++++++++++++++++++++++++++++++---
1 file changed, 37 insertions(+), 3 deletions(-)

diff --git a/HACKING.tex b/HACKING.tex
index be86ae1..f78d451 100644
--- a/HACKING.tex
+++ b/HACKING.tex
@@ -10,12 +10,36 @@
\begin{document}
\maketitle

-This is a living document. Suggestions for updates, via the
-\href{http://lists.quagga.net/mailman/listinfo/quagga-dev}{quagga-dev list},
+This is a living document describing the processes and guidelines for working on Quagga. You
+
+Suggestions for updates, via the \href{http://lists.quagga.net/mailman/listinfo/quagga-dev}{quagga-dev list},
are welcome.

\tableofcontents

+\label{sec:required}
+
+Note well: By proposing a change to Quagga, by whatever means, you are implicitly agreeing:
+
+\begin{itemize}
+  \item To licence your contribution according to the licence of any files in Quagga being
+        modified.
+
+  \item That it is your responsibility to ensure you hold whatever rights are required to be
+        able to contribute this change under the licenses of the files in Quagga being
+        modified.
+
+  \item That it is your responsibility to give with the contribution a full account of all
+        interests held and claims in the contribution; such as through copyright, trademark and
+        patent laws or otherwise; that are known to you or your associates (e.g. your employer).
+\end{itemize}
+
+Before contributing to Quagga, you \textbf{must} also read Section~\ref{sec:commit-messages}.
+You \textit{should} ideally read the entire document, as it contains useful information on
+the community norms and how to implement them.
+
\section{GUIDELINES FOR HACKING ON QUAGGA}
\label{sec:guidelines}

@@ -187,6 +211,7 @@ defined (watch your AC\_DEFINEs).

\section{COMMIT MESSAGES}
+\label{sec:commit-messages}

The commit message requirements are:

@@ -220,8 +245,17 @@ The commit message requirements are:
\item Information to allow reviewers to be able to tell which specific
changes to the code are intended (and hence be able to spot any accidental
unintended changes).
-
\end{itemize}
+  \item The commit message \textbf{must} give details of all the authors of the change,
+        beyond the person listed in the Author field. Any and all affiliations which
+        may have a bearing on copyright in any way should be given,
+        unless those affiliations are already obvious from other details,
+        e.g. from the email address. This would cover employment and contracting
+        obligations (give details).
+
+  \item If the change introduces a new dependency on any code or other copyrighted
+        material, please explicitly note this. Give details of what that external material
+        is, the copyright licence the material may be used under, and the nature of the dependency.
\end{itemize}

The one-line summary must be limited to 54 characters, and all other
--
2.1.0