From 10d420614c473f0f728b340f9172aa89c5a8e065 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 20 Jun 2009 21:00:21 +0200 Subject: [PATCH] [DOC] give some hints on how to hack ccollect Signed-off-by: Nico Schottelius --- README | 2 ++ doc/HACKING | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 doc/HACKING diff --git a/README b/README index e74464d..401d778 100644 --- a/README +++ b/README @@ -17,6 +17,8 @@ ccollect was inspired by rsnapshot [1], which has some problems: Please use tools/report_success.sh to report success, if you are successfully using ccollect. +Have a look at doc/HACKING, if you plan to change ccollect. + A small try to visualize the differences in a table: +---------------+-------------------------------------------------------------+ diff --git a/doc/HACKING b/doc/HACKING new file mode 100644 index 0000000..00db4d1 --- /dev/null +++ b/doc/HACKING @@ -0,0 +1,37 @@ +Hello Hacker, + +I really appreciate your interest in hacking this software, but +I am kind of critical when seeing patches. Thus I created this +file to give you some hints of my thinking quirks. + + +Submitting patches +------------------ +Make my life easier, make your life easier, use a version control system (vcs). +For this software the preferred vcs is git. Clone the latest repo, create +a new local branch (git checkout -b ) write down your ideas. + +When you're done, push all your stuff out to some public repo and drop a +mail to the mailinglist, what you did and where to get it. + + +Introduce a feature or change behaviour +--------------------------------------- +Uhh, fancy! You have had a great idea, then it's time to change +the major version, so others know that something changed. + +If the configuration format is changed, add a script to tools/ +to allow users upgrade their configuration to this major version. + +And now comes the most difficult part: Add documentation. Nobody +benefits from your cool feature, if it is not known. I know, writing +documentation is not so much fun, but you also expect good documentation +for this software, don't you? + + +If you think my thinking quirks must be corrected +------------------------------------------------- +See above ("Submitting patches") and submit a patch to this file. + + +Thanks for reading.