source: trunk/base/HACKING @ 29367

Last change on this file since 29367 was 28702, checked in by eridius@…, 13 years ago

Add basic HACKING file with my rules as documented on the list. Include Blair's suggestion for Makefiles

File size: 1020 bytes
RevLine 
[28702]1Whitespace rules as discussed on the list:
2
3* All source code files MUST use soft tabs at a tabstop of 4. No hard tabs are allowed.
4* All source code files SHOULD have the following as the first line of the file:
5       # -*- Mode: Tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:et:sw=4:ts=4:sts=4
6   This is a modeline that works for both emacs and vim.
7* Portfiles SHOULD use soft tabs at a tabstop of 4, but implementation of this is left up to the discretion of the maintainer.
8* Portfiles SHOULD use the given modeline
9* Makefiles MUST use tabs as it is required by the syntax. Makefiles SHOULD use a tab stop of 8.
10* Makefiles MAY use a modeline. The following works for emacs and vim:
11       # -*- Mode: Makefile; tab-width: 8; indent-tabs-mode: t -*- vim:noet:sw=8:ts=8
12* All other files (documentation, etc) SHOULD use soft tabs at a tabstop of 4 if the document format allows.
13* All other files (documentation, etc) SHOULD NOT use a modeline as it is probably meant for human consumption.
Note: See TracBrowser for help on using the repository browser.