| blob | a807a32d39a82b6d2b3a47b320e75c88ed48038a |
1 \r
2 \r
3 \r
4 # overview\r
5 ==========\r
6 here defines the rules for the developer of src-pkg to be followed with.\r
7 \r
8 @ less rules, more guide. the rules defined should be executable in develop.\r
9 @ do more design works like a calculation question, which has fixed method and\r
10 fixed answer. DECREASE(not though away) design works like ask/answer \r
11 question, which has no fixed method and answer.\r
12 @ use auto-utils as more as posiable, to follow the rules and guide without\r
13 burden.\r
14 @ checking format of src code with 'codefmt' before publish, it keep code clean\r
15 clear and readable.\r
16 @ dir structure of src-pkg must following the guide in this doc. use src-pkg\r
17 template, and wrting docs in it for src-pkg infomation.(such as README, AUTHOR, changelog, NEWS, TODO, THANKS, and so on).\r
18 \r
19 \r
20 \r
21 [¹æÔò]\r
22 @ ¹æÔò¶¨ÒåµÄÉÙ¶ø¾«£¬Êµ¼Ê¿É²Ù×÷µÄ¹æÔò¡£\r
23 @ ´úÂë·ç¸ñ¡£´úÂëÒÔÒ»¶¨µÄ¿ò¼ÜºÍ¸ñʽ±àд£¬Ê¹ÓÃcomment-tag±ê¼Ç´úÂëÖи÷¸öÓï·¨ÌØÐÔ\r
24 ²¿·Ö£¬±ãÓÚ³ÌÐò½âÎö¡£Í¬Ê±´úÂëÒÔÒ»ÖÖ´úÂë·ç¸ñ±àд£¬³ÌÐò¿´ÉÏÈ¥¸üÕû½à¡£²Î¿¼\r
25 "code-style-rules"¡£\r
26 @ Ò»¸öÈí¼þ°üÓ¦°üº¬GNUÔ´Âë°üËùÐèµÄÎĵµ¡£\r
27 @ ¿ª·¢Á÷³Ì¡£³ÌÐòµÄidea£¬µ½Éè¼Æ¡¢±àÂë¡¢µ÷ÊÔ¡¢²âÊÔ¡¢·¢²¼£¬×ñѳÌÐò¿ª·¢Á÷³Ì¡£²Î¿¼"project-develop-flow"\r
28 \r
29 \r
30 @ less rule defination£¬more executable rules¡£\r
31 @ code sytle. pay attension on code sytle, and use code-format util to format code automatically before new version publish.\r
32 @ a src pkg should contain full-doc as a standard GNU src pkg.\r
33 @ develop flow. a src pkg or a project follows develop flow rules, reference from "project-develop-flow.txt".\r
34 @ \r
35 \r
36 \r
37 [½¨Òé¹æÔò]\r
38 @ Ä£°å\r
39 # Èí¼þ°ü¹¤³ÌÄ£°å¡£Ò»¸öÈí¼þ°üµÄÎļþ¡¢Ä¿Â¼½á¹¹£¬Ê¹Óù¤³ÌÄ£°å£¬ÊÇÒ»¸öÈí¼þ°ü¿ª·¢µÄÆðµã¡£\r
40 # Ô´´úÂëÄ£°å¡£Ô´ÂëÎļþÐè°üº¬ÎļþÐÅϢͷ¡¢´ø×¢ÊÍ·Ö¸ôµÄ±à³ÌÓïÑÔÓï·¨ÌØÐԵĴúÂëʵÏÖ¡£Ê¹ÓÃtmpl»òcodegen²úÉúµÄ´úÂë¿ò¼Ü±àÂ룬¶ø²»ÊÇÊÖ¹¤\r
41 ±àдÎļþ¡£\r
42 @ »ù´¡±à³ÌÓïÑÔ֪ʶ¡£Ê¹ÓÃͨÓõÄ֪ʶºÍ¼¼Êõ±àд´úÂ룬¶ø·Çif/else/for/whileȥʵÏÖ´úÂë¡£\r
43 @ ¹¹½¨Í¨ÓõĴúÂë´¦Àí³ÌÐò¿â¡£ÒÔͨÓôúÂë¿âµÄ·½·¨±àд´úÂë¡£ÀýÈ磺Êý¾Ý½á¹¹£¬×é¼þ¼¼Êõ£¬MVPÄ£ÐÍ»¯³ÌÐòÉè¼Æ¡£\r
44 \r
45 @ ʹÓÃͨÓõÄÅäÖÃÎļþºÍÊý¾ÝÎļþ¸ñʽ£¬°üÀ¨imi¡¢catalog¡¢xml¡¢rec¡¢csv¡¢db¡£\r
46 \r
47 ===============================\r