Mercurial > hg > index.cgi

comparison 00README.txt @ 574:a0c9433dc0d4 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated submission guidelines including notes about evangelism. TLDR: Don't.
author William Astle <lost@l-w.ca>
date Mon, 04 Mar 2024 10:10:38 -0700
parents 4130ffdeb5c8
children
comparison
equal deleted inserted replaced
573:0ae10ecfba1e 574:a0c9433dc0d4
27 ============ 27 ============
28 28
29 If you wish to contribute patches or code to lwtools, please keep the 29 If you wish to contribute patches or code to lwtools, please keep the
30 following in mind. 30 following in mind.
31 31
32 Evangelism
33 ----------
34
35 Any communication that includes evangelism for alternate revision control
36 systems, coding styles, development methodologies, or similar will be
37 deleted with all other contents ignored. So just don't do it and save
38 yourself and the project maintainers time.
39
32 Style 40 Style
33 ----- 41 -----
34 42
35 The code formatting style must match the rest of the lwtools code. Code 43 The code formatting style must match the rest of the lwtools code. Code
36 submitted in the "1TBS" will be rejected out of hand. Attempts to convince 44 submitted in the "1TBS" will be rejected out of hand. Attempts to convince
37 me to change my mind on this point will be routed to /dev/null at best and 45 me to change my mind on this point will be routed to /dev/null at best and
38 likely met with extreme rudeness. 46 likely met with extreme rudeness.
39 47
40 C code should be formatted as follows: 48 C code should be formatted as follows:
41 49
42 * All indentation uses a single TAB character for each step. That is a HARD 50 * In general, match the formatting of the surrounding code, whether that
43 tab, not a series of spaces. TABs are assumed to be 4 characters though 51 uses spaces or tabs. Otherwise, all indentation uses a single TAB
44 that will largely impact only lining up comments and tabular code. If the 52 character for each step. That is a HARD tab, not a series of spaces. TABs
45 actual formatting of the code is critical, spaces may be used for that 53 are assumed to be 4 characters though that will largely impact only lining
46 formatting but the actual initial indentation of the lines MUST use TAB 54 up comments and tabular code. If the actual formatting of the code is
47 characters. 55 critical, spaces may be used for that formatting but the actual initial
56 indentation of the lines MUST use TAB characters.
48 * The opening brace for a block appears on the line below the control 57 * The opening brace for a block appears on the line below the control
49 structure that introduces it. It appears lined up with the preceding line 58 structure that introduces it. It appears lined up with the preceding line
50 and nothing else appears on the same line. 59 and nothing else appears on the same line.
51 * Closing braces appear on a line by themselves ordinarily. The exception is 60 * Closing braces appear on a line by themselves ordinarily. The exception is
52 the "while" keyword in a "do-while" statement appears on the same line as 61 the "while" keyword in a "do-while" statement appears on the same line as
67 style may be less strict. 76 style may be less strict.
68 77
69 Submitting 78 Submitting
70 ---------- 79 ----------
71 80
81 Any attempts to evangelize git or any other alternative revision control
82 system will be deleted with *all* other contents ignored.
83
72 When submitting code to lwtools, it should be submitted as a patch file (hg 84 When submitting code to lwtools, it should be submitted as a patch file (hg
73 diff or diff -u). DO NOT submit entire source files. Remember, others may be 85 diff or diff -u). DO NOT submit entire source files. Remember, others may be
74 working on changes, too, and your complete source files are difficult to 86 working on changes, too, and your complete source files are difficult to
75 merge with such situations. By submitting complete source files, you are 87 merge with such situations. By submitting complete source files, you are
76 making far more work for the maintainer and it is generally considered rude. 88 making far more work for the maintainer and it is generally considered rude.