[easytag] Update HACKING with new coding style
- From: David King <davidk src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [easytag] Update HACKING with new coding style
- Date: Tue, 4 Dec 2012 17:33:35 +0000 (UTC)
commit ff9516c8c7be67e5674f85a94d9e6f90b24c9717
Author: David King <amigadave amigadave com>
Date: Tue Dec 4 17:07:22 2012 +0000
Update HACKING with new coding style
Additionally, include mailing list address and Bugzilla location.
HACKING | 53 +++++++++++++++++++----------------------------------
1 files changed, 19 insertions(+), 34 deletions(-)
---
diff --git a/HACKING b/HACKING
index bcd5cad..d6ac02b 100644
--- a/HACKING
+++ b/HACKING
@@ -1,45 +1,30 @@
-This version of EasyTag is maintained in a git repository on github as
-the project never had a publicly accessible version control
-repository. The initial repository was created from a number of
-publicly available tarballs. You can find the current state of the
-repository at:
-
- https://github.com/stsquad/easytag
-
-It is intended as a place where patches and pull requests can be
-processed until JÃrÃme starts making releases again (hopefully with a
-public repo). In the meantime patches that look sane and don't crash
-EasyTag it will be accepted by myself.
+Hacking on EasyTAG
+==================
Contributing
-============
-
-My preferences for contributions are as follows:
+------------
-1. Pull request on github
-2. Pull request from another git repository
-3. Patches
+If you have a suggestion or found a bug, please either file a bug:
-Patches are fine but GIT pull requests make it a lot easier to keep
-attribution correct and it makes my life easier ;-)
+https://bugzilla.gnome.org/enter_bug.cgi?product=easytag
-Coding Style
-============
-
-I couldn't find any reference to the style to follow but running
-indent_finder.py suggests the code is currently:
+or bring it up on the mailing list:
- No Tabs, Indent Level of 4 characters
+easytag-list gnome org
-In Emacs the style can be set by the following:
+Patches are best filed on Bugzilla, but a pull request is also fine.
- (defconst easytag-c-style
- '(
- (indent-tabs-mode . nil)
- (c-basic-offset . 4)
- (c-comment-only-line-offset . 0))
- "EasyTag Programming Style")
+Coding Style
+------------
-
+The original EasyTAG coding style was close to K&R style, with four-space
+indents. This has been changed slightly to the following guidelines:
+* BSD/Allman brace style
+* One space before opening bracket, none after opening or closing
+* Four space indent
+* Try to keep to 80 character lines
+* Space after ',', spaces around logical operators
+* Function return values on a line separate from the function name
+New code should follow this style.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]