Author: ArcRiley Date: 2009-01-17 20:22:13 -0500 (Sat, 17 Jan 2009) New Revision: 1488
Added: trunk/concordance/HACKING Modified: trunk/concordance/INSTALL Log: HACKING guide added Added: trunk/concordance/HACKING =================================================================== --- trunk/concordance/HACKING (rev 0) +++ trunk/concordance/HACKING 2009-01-18 01:22:13 UTC (rev 1488) @@ -0,0 +1,57 @@ +Concordance Hacking Guide +========================= +or, how to contribute code that doesn't suck +-------------------------------------------- + +Introduction +~~~~~~~~~~~~ +As a copyleft community project Concordance is worked on by a large number of +users. Each of these users have their own preferences for code layout and +with their own unique styles. Without some structure applied to this process +the project would devolve into an unparsable, unmaintainable mess. + +We also benefit a great deal from developers working from "different angles". +A problem addressed with one solution may be very difficult, while by another +method very easy. Guidelines set too strictly would thus dampen the beautiful +dissonance that makes our community so strong. + +So in an attempted balance these guidelines are set forth. Use them when it +makes sense to, bend or break them when nessesary, and don't complain if +someone cleans your code up to better meet these guidelines. + + +Linkage +~~~~~~~ + +Every Concordance module is expected to link to _core.so (concordance._core) +in some manner. _core should not link to any other module. + + +Code Layout +~~~~~~~~~~~ + + * Lines should be no longer than 80 characters (maximum) + + - wrap parameter lists indented to start of list (stacked vertically) + + - move function returns to variables to shorten long lines + + - try to minimize deeply-nested code + + * 2 space indententation + + - tabs do not copy/paste for some + + - many editors (kate, gedit) allow you to see this in more intuitive ways + +Label Conventions +~~~~~~~~~~~~~~~~~ + + * Modules should be all lowercase + + * Classes should begin with uppercase + + * Methods and properties should be with lowercase + + * Use capital letters to separate words, ie, MyClass, not My_Class or My_class + Modified: trunk/concordance/INSTALL =================================================================== --- trunk/concordance/INSTALL 2009-01-17 20:14:00 UTC (rev 1487) +++ trunk/concordance/INSTALL 2009-01-18 01:22:13 UTC (rev 1488) @@ -1,5 +1,5 @@ Concordance Installation Guide -======================== +============================== Dependencies ------------ You'll want to make sure these are installed before proceeding: _______________________________________________ PySoy-SVN mailing list PySoy-SVN@pysoy.org http://www.pysoy.org/mailman/listinfo/pysoy-svn
