I've pushed out 1 and 2 of this, as they were fairly trivial. This one has
been acked too, and no specific objections since. If anyone has objections
or tweaks to make to the text, please speak up. Otherwise I will push it
out by the end of the week.
Again, for anyone who contributes to Quagga I would very much encourage
any such person feels (to any degree) that their contribution gives them
or another party a copyright interest in the code that they add:
"Copyright (C) <year> <copyright holder details>"
to such files.
Note: It is much better to err on the side of *adding* your claim!
On Mon, 27 Oct 2014, Paul Jakma wrote:
* 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.
(REQUIRED READING) Add a section on what people are implicitly agreeing
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.
---
HACKING.tex | 40 +++++++++++++++++++++++++++++++++++++---
1 file changed, 37 insertions(+), 3 deletions(-)
diff --git a/HACKING.tex b/HACKING.tex
index acb33fd..26273ff 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
+\textbf{must} read Section~\ref{sec:required}, "REQUIRED READING", before
contributing to Quagga.
+
+Suggestions for updates, via the
\href{http://lists.quagga.net/mailman/listinfo/quagga-dev}{quagga-dev list},
are welcome.
\tableofcontents
+\section{REQUIRED READING}
+\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, \textit{and} according to the COPYING file in the top-level
directory of Quagga.
+
+ \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
+ and the COPYING file.
+
+ \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}
@@ -125,6 +149,7 @@ defined (watch your AC\_DEFINEs).
\section{COMMIT MESSAGES}
+\label{sec:commit-messages}
The commit message requirements are:
@@ -158,8 +183,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
--
Paul Jakma [email protected] @pjakma Key ID: 64A2FF6A
Fortune:
This sentence no verb.
_______________________________________________
Quagga-dev mailing list
[email protected]
https://lists.quagga.net/mailman/listinfo/quagga-dev
