From 2934f28ef196ffeb414c9fb8667742d053bc8b40 Mon Sep 17 00:00:00 2001
From: gdt <gdt>
Date: Mon, 5 Jan 2004 20:09:00 +0000
Subject: move changelog section up higher.

Add notion of commenting for reviewers and taking care to not break
platforms one cannot test on.
---
 HACKING | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

(limited to 'HACKING')

diff --git a/HACKING b/HACKING
index 4fedb34e..d621136f 100644
--- a/HACKING
+++ b/HACKING
@@ -1,6 +1,6 @@
 -*- mode: text; -*-
 
-$Id: HACKING,v 1.3 2003/12/23 08:56:18 jardin Exp $
+$Id: HACKING,v 1.4 2004/01/05 20:09:00 gdt Exp $
 
 GUIDELINES FOR HACKING ON QUAGGA
 
@@ -12,6 +12,25 @@ Generally, GNU coding standards apply.  The indentation style is a bit
 different from standard GNU style, and the existing style should be
 maintained and used for new code.
 
+Be particularly careful not to break platforms/protocols that you
+cannot test.
+
+New code should have good comments, and changes to existing code
+should in many cases upgrade the comments when necessary for a
+reviewer to conclude that the change has no unintended consequences.
+
+CHANGELOG
+
+Add a ChangeLog entry whenever changing code, except for minor fixes
+to a commit (with a ChangeLog entry) within the last few days.
+
+There is at present a mixed style for ChangeLog, with some changes
+being described in per-directory ChangeLog files, and some at top
+level.
+
+[TBD: resolve per-dir vs top-level, perhaps by reading GNU coding
+standards]
+
 PATCH SUBMISSION
 
 * Send a clean diff against the head of CVS.
@@ -68,10 +87,6 @@ tested are:
   ospfd
   ripngd
 
-CHANGELOG
-
-[TBD: when to add to per-dir Changelog, when to add to top-level]
-
 IMPORT OR UPDATE VENDOR SPECIFIC ROUTING PROTOCOLS
 
 The source code of Quagga is based on two vendors:
-- 
cgit v1.2.1