summaryrefslogtreecommitdiffstats
path: root/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING68
1 files changed, 68 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..600c92e
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,68 @@
+=================
+DEVELOPMENT NOTES
+=================
+
+:Last update: $Date: 2007-12-18 14:32:42 +0100 (Di, 18 Dez 2007) $
+:Revision: $Revision: 8 $
+:Contact: p@rdus.de
+
+Changes
+-------
+
+ 1) Any change should get a short ChangeLog entry.
+
+ 2) Bigger changes, feature enhancements and closed bugs go into
+ CHANGES
+
+ 3) The RELEASE_NOTES should contain a summary for the current release
+ as well as a list of enhancements and closed bugs.
+
+
+Versions
+--------
+
+ The version number is being recorded in layman/version.py.
+
+ The version number for release packages has three numbers.
+
+ SVN versions should have the date of the last commit appended.
+
+
+Authors
+-------
+
+ Please do not forget to add new authors or contributors within
+ AUTHORS.
+
+
+Release management
+------------------
+
+ No instructions yet.
+
+
+Branches
+--------
+
+ No branches yet.
+
+
+Documentation
+-------------
+
+ The documentation can be found as man page in layman/doc. The source
+ file layman/doc/layman.8.xml is in DocBook format.
+
+
+Testing
+-------
+
+The central testing script is llayman/tests/dtest.py
+
+To run the tests, move into the layman root directory and run
+
+ PYTHONPATH="." python layman/tests/dtest.py
+
+The tests should not fail.
+
+