Fossil SCM

Added the Checklist for Successful Open-Source Projects document. [/doc/trunk/www/foss-cklist.wiki]

drh 2011-07-14 13:02 trunk

Commit 34177b0068e30b2fee9925b11e61e8e0f7f6b2eb

Parent fd13b1a16f8b4f0…

3 files changed +60 +8 -6 +4 -1

+ www/foss-cklist.wiki ~ www/mkindex.tcl ~ www/permutedindex.wiki

A www/foss-cklist.wiki

+60

		--- a/www/foss-cklist.wiki
		+++ b/www/foss-cklist.wiki
		@@ -0,0 +1,60 @@
	1	+<title>Checklist For Successful Open-Source Projects</title>
	2	+<nowiki>
	3	+
	4	+<p>This checklist is loosely derived from Tom "Spot" Callaway's Fail Score
	5	+blog post <a href="http://spot.livejournal.com/308370.html">
	6	+http://spot.livejournal.com/308370.html</a> (see also
	7	+<a href="http://www.theopensourceway.org/book/The_Open_Source_Way-How_to_tell_if_a_FLOSS_project_is_doomed_to_FAIL.html">[1]</a> and
	8	+<a href="https://wwwHow_to_tell_if_a_FLOSS_project_is_doomed_to_FAIL.html">[1]</a>).
	9	+Tom's original post assigned point scores to the various elements and
	10	+by adding together the individual points, the reader is suposed to be able
	11	+to judge the likelihood that the project will fail.
	12	+The point scores, and the items on the list, clearly reflect Tom's
	13	+biases and are not necessarily those of the larger open-source community.
	14	+Nevertheless, the policy of the Fossil shall be to strive for a perfect
	15	+score.</p>
	16	+
	17	+<p>rive for a perfect
	18	+score.
	19	+
	20	+This checklist is an inversion of Tom's original post in that it strives to
	21	+say what the project should do in order to succeed rather than what it
	22	+should not do to avoid failure. Th</p>
	23	+
	24	+<p>point values are omitted.
	25	+
	26	+See also:
	27	+<ul>
	28	+<li><a href="http://offog.org/articles/packaging/">
	29	+http://offog.org/articles/packaging/</a>
	30	+<li>
	31	+<a href="http://www.gnu.org/prep/standards/standards.html#Managing-Releases">
	32	+http://www.gnu.org/prep/standards/standards.html#Managing-Releases<p>The source code size is less than <p>The project uses a Version Control System (VCS).
	33	+<ol type="a">
	34	+<li>The VCS has a working web interface.
	35	+<li>There is documentation on how to use the VCS.
	36	+<li>The VCS is general-purpose, not something hacked together for this
	37	+ <p>The project comes with documentation on how to build from source
	38	+and that documentation is lucid, correct, and up-to-date.
	39	+
	40	+<li><p>The project is configurable using an autoconf-generated configure
	41	+script, or the equivalent, and does not require:
	42	+<ol type="a">
	43	+<li>Manually editing flat files
	44	+<li>Editing code header files
	45	+</ol>
	46	+
	47	+<li><pes a Version les
	48	+</ol>
	49	+
	50	+<li>The project should be buildable using commonly available and
	51	+ standa<p Open-Source Projects</title>
	52	+<nowiki>
	53	+
	54	+This checklist is loosely derive<t>The project is configurable using an autoconf-generated configure
	55	+script, or the equivalent, and does not requir essful Open-Source Projects</title>
	56	+<nowiki>
	57	+
	58	+<p>This checklist is loosely derived from Tom "Spot" Callaway's Fail Score
	59	+blog post <a href="http://spot.livejournal.com/308370.html">
	60	+http://sp

	--- a/www/foss-cklist.wiki
	+++ b/www/foss-cklist.wiki
	@@ -0,0 +1,60 @@

	--- a/www/foss-cklist.wiki
	+++ b/www/foss-cklist.wiki
	@@ -0,0 +1,60 @@
1	<title>Checklist For Successful Open-Source Projects</title>
2	<nowiki>
3
4	<p>This checklist is loosely derived from Tom "Spot" Callaway's Fail Score
5	blog post <a href="http://spot.livejournal.com/308370.html">
6	http://spot.livejournal.com/308370.html</a> (see also
7	<a href="http://www.theopensourceway.org/book/The_Open_Source_Way-How_to_tell_if_a_FLOSS_project_is_doomed_to_FAIL.html">[1]</a> and
8	<a href="https://wwwHow_to_tell_if_a_FLOSS_project_is_doomed_to_FAIL.html">[1]</a>).
9	Tom's original post assigned point scores to the various elements and
10	by adding together the individual points, the reader is suposed to be able
11	to judge the likelihood that the project will fail.
12	The point scores, and the items on the list, clearly reflect Tom's
13	biases and are not necessarily those of the larger open-source community.
14	Nevertheless, the policy of the Fossil shall be to strive for a perfect
15	score.</p>
16
17	<p>rive for a perfect
18	score.
19
20	This checklist is an inversion of Tom's original post in that it strives to
21	say what the project should do in order to succeed rather than what it
22	should not do to avoid failure. Th</p>
23
24	<p>point values are omitted.
25
26	See also:
27	<ul>
28	<li><a href="http://offog.org/articles/packaging/">
29	http://offog.org/articles/packaging/</a>
30	<li>
31	<a href="http://www.gnu.org/prep/standards/standards.html#Managing-Releases">
32	http://www.gnu.org/prep/standards/standards.html#Managing-Releases<p>The source code size is less than <p>The project uses a Version Control System (VCS).
33	<ol type="a">
34	<li>The VCS has a working web interface.
35	<li>There is documentation on how to use the VCS.
36	<li>The VCS is general-purpose, not something hacked together for this
37	<p>The project comes with documentation on how to build from source
38	and that documentation is lucid, correct, and up-to-date.
39
40	<li><p>The project is configurable using an autoconf-generated configure
41	script, or the equivalent, and does not require:
42	<ol type="a">
43	<li>Manually editing flat files
44	<li>Editing code header files
45	</ol>
46
47	<li><pes a Version les
48	</ol>
49
50	<li>The project should be buildable using commonly available and
51	standa<p Open-Source Projects</title>
52	<nowiki>
53
54	This checklist is loosely derive<t>The project is configurable using an autoconf-generated configure
55	script, or the equivalent, and does not requir essful Open-Source Projects</title>
56	<nowiki>
57
58	<p>This checklist is loosely derived from Tom "Spot" Callaway's Fail Score
59	blog post <a href="http://spot.livejournal.com/308370.html">
60	http://sp

M www/mkindex.tcl

+8 -6

		--- www/mkindex.tcl
		+++ www/mkindex.tcl
		@@ -19,10 +19,11 @@
19	19	delta_format.wiki {Fossil Delta Format}
20	20	embeddeddoc.wiki {Embedded Project Documentation}
21	21	event.wiki {Events}
22	22	faq.wiki {Frequently Asked Questions}
23	23	fileformat.wiki {Fossil File Format}
	24	+ foss-cklist.wiki {Checklist For Successful Open-Source Projects}
24	25	fossil-v-git.wiki {Fossil Versus Git}
25	26	index.wiki {Home Page}
26	27	inout.wiki {Import And Export To And From Git}
27	28	makefile.wiki {The Fossil Build Process}
28	29	password.wiki {Password Management And Authentication}
		@@ -47,11 +48,11 @@
47	48	webui.wiki {The Fossil Web Interface}
48	49	wikitheory.wiki {Wiki In Fossil}
49	50	}
50	51
51	52	set permindex {}
52		-set stopwords {fossil and a in of on the to are about used by}
	53	+set stopwords {fossil and a in of on the to are about used by for or}
53	54	foreach {file title} $doclist {
54	55	set n [llength $title]
55	56	lappend permindex [list $title $file]
56	57	for {set i 0} {$i<$n-1} {incr i} {
57	58	set prefix [lrange $title 0 $i]
		@@ -61,13 +62,14 @@
61	62	lappend permindex [list "$suffix $prefix" $file]
62	63	}
63	64	}
64	65	}
65	66	set permindex [lsort -dict $permindex]
66		-puts "<title>Permuted Index Of Fossil Documentation</title>"
67		-puts "<nowiki>"
68		-puts "<ul>"
	67	+set out [open permutedindex.wiki w]
	68	+puts $out "<title>Permuted Index Of Fossil Documentation</title>"
	69	+puts $out "<nowiki>"
	70	+puts $out "<ul>"
69	71	foreach entry $permindex {
70	72	foreach {title file} $entry break
71		- puts "<li><a href=\"$file\">$title</a></li>"
	73	+ puts $out "<li><a href=\"$file\">$title</a></li>"
72	74	}
73		-puts "</ul>"
	75	+puts $out "</ul>"
74	76

	--- www/mkindex.tcl
	+++ www/mkindex.tcl
	@@ -19,10 +19,11 @@
19	delta_format.wiki {Fossil Delta Format}
20	embeddeddoc.wiki {Embedded Project Documentation}
21	event.wiki {Events}
22	faq.wiki {Frequently Asked Questions}
23	fileformat.wiki {Fossil File Format}

24	fossil-v-git.wiki {Fossil Versus Git}
25	index.wiki {Home Page}
26	inout.wiki {Import And Export To And From Git}
27	makefile.wiki {The Fossil Build Process}
28	password.wiki {Password Management And Authentication}
	@@ -47,11 +48,11 @@
47	webui.wiki {The Fossil Web Interface}
48	wikitheory.wiki {Wiki In Fossil}
49	}
50
51	set permindex {}
52	set stopwords {fossil and a in of on the to are about used by}
53	foreach {file title} $doclist {
54	set n [llength $title]
55	lappend permindex [list $title $file]
56	for {set i 0} {$i<$n-1} {incr i} {
57	set prefix [lrange $title 0 $i]
	@@ -61,13 +62,14 @@
61	lappend permindex [list "$suffix $prefix" $file]
62	}
63	}
64	}
65	set permindex [lsort -dict $permindex]
66	puts "<title>Permuted Index Of Fossil Documentation</title>"
67	puts "<nowiki>"
68	puts "<ul>"

69	foreach entry $permindex {
70	foreach {title file} $entry break
71	puts "<li><a href=\"$file\">$title</a></li>"
72	}
73	puts "</ul>"
74

	--- www/mkindex.tcl
	+++ www/mkindex.tcl
	@@ -19,10 +19,11 @@
19	delta_format.wiki {Fossil Delta Format}
20	embeddeddoc.wiki {Embedded Project Documentation}
21	event.wiki {Events}
22	faq.wiki {Frequently Asked Questions}
23	fileformat.wiki {Fossil File Format}
24	foss-cklist.wiki {Checklist For Successful Open-Source Projects}
25	fossil-v-git.wiki {Fossil Versus Git}
26	index.wiki {Home Page}
27	inout.wiki {Import And Export To And From Git}
28	makefile.wiki {The Fossil Build Process}
29	password.wiki {Password Management And Authentication}
	@@ -47,11 +48,11 @@
48	webui.wiki {The Fossil Web Interface}
49	wikitheory.wiki {Wiki In Fossil}
50	}
51
52	set permindex {}
53	set stopwords {fossil and a in of on the to are about used by for or}
54	foreach {file title} $doclist {
55	set n [llength $title]
56	lappend permindex [list $title $file]
57	for {set i 0} {$i<$n-1} {incr i} {
58	set prefix [lrange $title 0 $i]
	@@ -61,13 +62,14 @@
62	lappend permindex [list "$suffix $prefix" $file]
63	}
64	}
65	}
66	set permindex [lsort -dict $permindex]
67	set out [open permutedindex.wiki w]
68	puts $out "<title>Permuted Index Of Fossil Documentation</title>"
69	puts $out "<nowiki>"
70	puts $out "<ul>"
71	foreach entry $permindex {
72	foreach {title file} $entry break
73	puts $out "<li><a href=\"$file\">$title</a></li>"
74	}
75	puts $out "</ul>"
76

M www/permutedindex.wiki

+4 -1

		--- www/permutedindex.wiki
		+++ www/permutedindex.wiki
		@@ -13,10 +13,11 @@
13	13	<li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
14	14	<li><a href="makefile.wiki">Build Process The Fossil</a></li>
15	15	<li><a href="build.wiki">Building and Installing Fossil</a></li>
16	16	<li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
17	17	<li><a href="../test/release-checklist.wiki">Checklist Pre-Release Testing</a></li>
	18	+<li><a href="foss-cklist.wiki">Checklist For Successful Open-Source Projects</a></li>
18	19	<li><a href="selfcheck.wiki">Checks Fossil Repository Integrity Self</a></li>
19	20	<li><a href="contribute.wiki">Code or Documentation To The Fossil Project Contributing</a></li>
20	21	<li><a href="style.wiki">Code Style Guidelines Source</a></li>
21	22	<li><a href="concepts.wiki">Concepts Fossil Core</a></li>
22	23	<li><a href="server.wiki">Configure A Fossil Server How To</a></li>
		@@ -73,12 +74,12 @@
73	74	<li><a href="webui.wiki">Interface The Fossil Web</a></li>
74	75	<li><a href="copyright-release.html">License Agreement Contributor</a></li>
75	76	<li><a href="password.wiki">Management And Authentication Password</a></li>
76	77	<li><a href="branching.wiki">Merging, and Tagging Branching, Forking,</a></li>
77	78	<li><a href="checkin_names.wiki">Names Checkin And Version</a></li>
	79	+<li><a href="foss-cklist.wiki">Open-Source Projects Checklist For Successful</a></li>
78	80	<li><a href="pop.wiki">Operations Principles Of</a></li>
79		-<li><a href="contribute.wiki">or Documentation To The Fossil Project Contributing Code</a></li>
80	81	<li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil A Technical</a></li>
81	82	<li><a href="index.wiki">Page Home</a></li>
82	83	<li><a href="password.wiki">Password Management And Authentication</a></li>
83	84	<li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General Quotes: What</a></li>
84	85	<li><a href="stats.wiki">Performance Statistics</a></li>
		@@ -86,10 +87,11 @@
86	87	<li><a href="pop.wiki">Principles Of Operations</a></li>
87	88	<li><a href="private.wiki">Private Branches Creating, Syncing, and Deleting</a></li>
88	89	<li><a href="makefile.wiki">Process The Fossil Build</a></li>
89	90	<li><a href="contribute.wiki">Project Contributing Code or Documentation To The Fossil</a></li>
90	91	<li><a href="embeddeddoc.wiki">Project Documentation Embedded</a></li>
	92	+<li><a href="foss-cklist.wiki">Projects Checklist For Successful Open-Source</a></li>
91	93	<li><a href="sync.wiki">Protocol The Fossil Sync</a></li>
92	94	<li><a href="faq.wiki">Questions Frequently Asked</a></li>
93	95	<li><a href="qandc.wiki">Questions And Criticisms</a></li>
94	96	<li><a href="quickstart.wiki">Quick Start Guide Fossil</a></li>
95	97	<li><a href="quotes.wiki">Quotes: What People Are Saying About Fossil, Git, and DVCSes in General</a></li>
		@@ -103,10 +105,11 @@
103	105	<li><a href="style.wiki">Source Code Style Guidelines</a></li>
104	106	<li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
105	107	<li><a href="quickstart.wiki">Start Guide Fossil Quick</a></li>
106	108	<li><a href="stats.wiki">Statistics Performance</a></li>
107	109	<li><a href="style.wiki">Style Guidelines Source Code</a></li>
	110	+<li><a href="foss-cklist.wiki">Successful Open-Source Projects Checklist For</a></li>
108	111	<li><a href="sync.wiki">Sync Protocol The Fossil</a></li>
109	112	<li><a href="private.wiki">Syncing, and Deleting Private Branches Creating,</a></li>
110	113	<li><a href="custom_ticket.wiki">System Customizing The Ticket</a></li>
111	114	<li><a href="branching.wiki">Tagging Branching, Forking, Merging, and</a></li>
112	115	<li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil A</a></li>
113	116

	--- www/permutedindex.wiki
	+++ www/permutedindex.wiki
	@@ -13,10 +13,11 @@
13	<li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
14	<li><a href="makefile.wiki">Build Process The Fossil</a></li>
15	<li><a href="build.wiki">Building and Installing Fossil</a></li>
16	<li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
17	<li><a href="../test/release-checklist.wiki">Checklist Pre-Release Testing</a></li>

18	<li><a href="selfcheck.wiki">Checks Fossil Repository Integrity Self</a></li>
19	<li><a href="contribute.wiki">Code or Documentation To The Fossil Project Contributing</a></li>
20	<li><a href="style.wiki">Code Style Guidelines Source</a></li>
21	<li><a href="concepts.wiki">Concepts Fossil Core</a></li>
22	<li><a href="server.wiki">Configure A Fossil Server How To</a></li>
	@@ -73,12 +74,12 @@
73	<li><a href="webui.wiki">Interface The Fossil Web</a></li>
74	<li><a href="copyright-release.html">License Agreement Contributor</a></li>
75	<li><a href="password.wiki">Management And Authentication Password</a></li>
76	<li><a href="branching.wiki">Merging, and Tagging Branching, Forking,</a></li>
77	<li><a href="checkin_names.wiki">Names Checkin And Version</a></li>

78	<li><a href="pop.wiki">Operations Principles Of</a></li>
79	<li><a href="contribute.wiki">or Documentation To The Fossil Project Contributing Code</a></li>
80	<li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil A Technical</a></li>
81	<li><a href="index.wiki">Page Home</a></li>
82	<li><a href="password.wiki">Password Management And Authentication</a></li>
83	<li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General Quotes: What</a></li>
84	<li><a href="stats.wiki">Performance Statistics</a></li>
	@@ -86,10 +87,11 @@
86	<li><a href="pop.wiki">Principles Of Operations</a></li>
87	<li><a href="private.wiki">Private Branches Creating, Syncing, and Deleting</a></li>
88	<li><a href="makefile.wiki">Process The Fossil Build</a></li>
89	<li><a href="contribute.wiki">Project Contributing Code or Documentation To The Fossil</a></li>
90	<li><a href="embeddeddoc.wiki">Project Documentation Embedded</a></li>

91	<li><a href="sync.wiki">Protocol The Fossil Sync</a></li>
92	<li><a href="faq.wiki">Questions Frequently Asked</a></li>
93	<li><a href="qandc.wiki">Questions And Criticisms</a></li>
94	<li><a href="quickstart.wiki">Quick Start Guide Fossil</a></li>
95	<li><a href="quotes.wiki">Quotes: What People Are Saying About Fossil, Git, and DVCSes in General</a></li>
	@@ -103,10 +105,11 @@
103	<li><a href="style.wiki">Source Code Style Guidelines</a></li>
104	<li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
105	<li><a href="quickstart.wiki">Start Guide Fossil Quick</a></li>
106	<li><a href="stats.wiki">Statistics Performance</a></li>
107	<li><a href="style.wiki">Style Guidelines Source Code</a></li>

108	<li><a href="sync.wiki">Sync Protocol The Fossil</a></li>
109	<li><a href="private.wiki">Syncing, and Deleting Private Branches Creating,</a></li>
110	<li><a href="custom_ticket.wiki">System Customizing The Ticket</a></li>
111	<li><a href="branching.wiki">Tagging Branching, Forking, Merging, and</a></li>
112	<li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil A</a></li>
113

	--- www/permutedindex.wiki
	+++ www/permutedindex.wiki
	@@ -13,10 +13,11 @@
13	<li><a href="bugtheory.wiki">Bug Tracking In Fossil</a></li>
14	<li><a href="makefile.wiki">Build Process The Fossil</a></li>
15	<li><a href="build.wiki">Building and Installing Fossil</a></li>
16	<li><a href="checkin_names.wiki">Checkin And Version Names</a></li>
17	<li><a href="../test/release-checklist.wiki">Checklist Pre-Release Testing</a></li>
18	<li><a href="foss-cklist.wiki">Checklist For Successful Open-Source Projects</a></li>
19	<li><a href="selfcheck.wiki">Checks Fossil Repository Integrity Self</a></li>
20	<li><a href="contribute.wiki">Code or Documentation To The Fossil Project Contributing</a></li>
21	<li><a href="style.wiki">Code Style Guidelines Source</a></li>
22	<li><a href="concepts.wiki">Concepts Fossil Core</a></li>
23	<li><a href="server.wiki">Configure A Fossil Server How To</a></li>
	@@ -73,12 +74,12 @@
74	<li><a href="webui.wiki">Interface The Fossil Web</a></li>
75	<li><a href="copyright-release.html">License Agreement Contributor</a></li>
76	<li><a href="password.wiki">Management And Authentication Password</a></li>
77	<li><a href="branching.wiki">Merging, and Tagging Branching, Forking,</a></li>
78	<li><a href="checkin_names.wiki">Names Checkin And Version</a></li>
79	<li><a href="foss-cklist.wiki">Open-Source Projects Checklist For Successful</a></li>
80	<li><a href="pop.wiki">Operations Principles Of</a></li>

81	<li><a href="tech_overview.wiki">Overview Of The Design And Implementation Of Fossil A Technical</a></li>
82	<li><a href="index.wiki">Page Home</a></li>
83	<li><a href="password.wiki">Password Management And Authentication</a></li>
84	<li><a href="quotes.wiki">People Are Saying About Fossil, Git, and DVCSes in General Quotes: What</a></li>
85	<li><a href="stats.wiki">Performance Statistics</a></li>
	@@ -86,10 +87,11 @@
87	<li><a href="pop.wiki">Principles Of Operations</a></li>
88	<li><a href="private.wiki">Private Branches Creating, Syncing, and Deleting</a></li>
89	<li><a href="makefile.wiki">Process The Fossil Build</a></li>
90	<li><a href="contribute.wiki">Project Contributing Code or Documentation To The Fossil</a></li>
91	<li><a href="embeddeddoc.wiki">Project Documentation Embedded</a></li>
92	<li><a href="foss-cklist.wiki">Projects Checklist For Successful Open-Source</a></li>
93	<li><a href="sync.wiki">Protocol The Fossil Sync</a></li>
94	<li><a href="faq.wiki">Questions Frequently Asked</a></li>
95	<li><a href="qandc.wiki">Questions And Criticisms</a></li>
96	<li><a href="quickstart.wiki">Quick Start Guide Fossil</a></li>
97	<li><a href="quotes.wiki">Quotes: What People Are Saying About Fossil, Git, and DVCSes in General</a></li>
	@@ -103,10 +105,11 @@
105	<li><a href="style.wiki">Source Code Style Guidelines</a></li>
106	<li><a href="tech_overview.wiki">SQLite Databases Used By Fossil</a></li>
107	<li><a href="quickstart.wiki">Start Guide Fossil Quick</a></li>
108	<li><a href="stats.wiki">Statistics Performance</a></li>
109	<li><a href="style.wiki">Style Guidelines Source Code</a></li>
110	<li><a href="foss-cklist.wiki">Successful Open-Source Projects Checklist For</a></li>
111	<li><a href="sync.wiki">Sync Protocol The Fossil</a></li>
112	<li><a href="private.wiki">Syncing, and Deleting Private Branches Creating,</a></li>
113	<li><a href="custom_ticket.wiki">System Customizing The Ticket</a></li>
114	<li><a href="branching.wiki">Tagging Branching, Forking, Merging, and</a></li>
115	<li><a href="tech_overview.wiki">Technical Overview Of The Design And Implementation Of Fossil A</a></li>
116

Fossil SCM

Keyboard Shortcuts