From a59417a6cfa98bc2f4da8698c33e6abc3c9c53b3 Mon Sep 17 00:00:00 2001 From: dmiller Date: Wed, 21 Oct 2015 13:40:46 +0000 Subject: [PATCH] Update style guidance in HACKING file --- HACKING | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/HACKING b/HACKING index eb544b904..a380b8404 100644 --- a/HACKING +++ b/HACKING @@ -84,23 +84,18 @@ patches if you can. Style ----- -When contributing new code, we suggest using two-space indents with no -tabs. This is generally the default in emacs, and Vim users can -achieve it by adding rules such as the following to .vimrc: - -if getcwd() =~ '/nmap' - set nocindent - set expandtab - set softtabstop=2 - set shiftwidth=2 - set copyindent -endif +Code style guidelines and quality checking tools are documented at +https://secwiki.org/w/Nmap/Code_Standards . The short version is: +* Indent with 2 spaces, not tabs +* No trailing whitespace +* Be consistent +* Use comments Credits ------- -I got the idea for this HACKING file from GNet +I got the idea for this HACKING file from GNet (http://www.gnetlibrary.org/) and followed the general structure of their HACKING file.