forked from ungleich-public/ccollect
[DOC] give some hints on how to hack ccollect
Signed-off-by: Nico Schottelius <nico@ikn.schottelius.org>
This commit is contained in:
parent
ea16af51b2
commit
10d420614c
2 changed files with 39 additions and 0 deletions
2
README
2
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:
|
||||
|
||||
+---------------+-------------------------------------------------------------+
|
||||
|
|
37
doc/HACKING
Normal file
37
doc/HACKING
Normal file
|
@ -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 <branchname>) 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.
|
Loading…
Reference in a new issue