From 30a13ab5271ed2ec11a2b876c70c5cdce8b4276c Mon Sep 17 00:00:00 2001 From: Alex Bennee Date: Sat, 23 Apr 2011 16:25:49 +0100 Subject: Add a basic HACKING document to mention the prefered form for requests and what the coding style seems to be. --- HACKING | 45 +++++++++++++++++++++++++++++++++++++++++++++ README | 8 ++++++-- 2 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 HACKING diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..bcd5cad --- /dev/null +++ b/HACKING @@ -0,0 +1,45 @@ +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. + +Contributing +============ + +My preferences for contributions are as follows: + +1. Pull request on github +2. Pull request from another git repository +3. Patches + +Patches are fine but GIT pull requests make it a lot easier to keep +attribution correct and it makes my life easier ;-) + +Coding Style +============ + +I couldn't find any reference to the style to follow but running +indent_finder.py suggests the code is currently: + + No Tabs, Indent Level of 4 characters + +In Emacs the style can be set by the following: + + (defconst easytag-c-style + '( + (indent-tabs-mode . nil) + (c-basic-offset . 4) + (c-comment-only-line-offset . 0)) + "EasyTag Programming Style") + + + + diff --git a/README b/README index d710ebc..b957608 100644 --- a/README +++ b/README @@ -84,5 +84,9 @@ Visit the homepage at: http://easytag.sourceforge.net or: http://sourceforge.net/project/?group_id=5216 for more informations and new releases. -Please mail any bug reports, complaints, suggestions and comments to the -main author Jerome Couderc . +This version is currently being maintained in an external version +control repository. If you wish to make a contribution please see the +HACKING document. You may still of course mail the original author any +bug reports, complaints, suggestions and comments to the main author +Jerome Couderc . + -- cgit v1.2.3