/usr/share/doc/racket/style/index.html is in racket-doc 6.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>How to Program Racket</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">▼</a></td><td></td><td><a href="" class="tocviewselflink" data-pltdoc="x">How to Program Racket</a></td></tr></table></div><div class="tocviewsublistonly" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="correct-maintain-speed.html" class="tocviewlink" data-pltdoc="x">Basic Facts of Life</a></td></tr><tr><td align="right">2 </td><td><a href="testing.html" class="tocviewlink" data-pltdoc="x">Testing</a></td></tr><tr><td align="right">3 </td><td><a href="Units_of_Code.html" class="tocviewlink" data-pltdoc="x">Units of Code</a></td></tr><tr><td align="right">4 </td><td><a href="Choosing_the_Right_Construct.html" class="tocviewlink" data-pltdoc="x">Choosing the Right Construct</a></td></tr><tr><td align="right">5 </td><td><a href="Textual_Matters.html" class="tocviewlink" data-pltdoc="x">Textual Matters</a></td></tr><tr><td align="right">6 </td><td><a href="Language_and_Performance.html" class="tocviewlink" data-pltdoc="x">Language and Performance</a></td></tr><tr><td align="right">7 </td><td><a href="branch-and-commit.html" class="tocviewlink" data-pltdoc="x">Retiquette:<span class="mywbr"> </span> Branch and Commit</a></td></tr><tr><td align="right">8 </td><td><a href="Acknowledgment.html" class="tocviewlink" data-pltdoc="x">Acknowledgment</a></td></tr><tr><td align="right">9 </td><td><a href="Todo_List__Call_for_Contributions.html" class="tocviewlink" data-pltdoc="x">Todo List, Call for Contributions</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><span class="tocsublinknumber"></span><a href="#%28part._top%29" class="tocsubseclink" data-pltdoc="x">How to Program Racket</a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="versionbox"><span class="version">6.1</span></div><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <span class="nonavigation">← prev</span> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">up</a> <a href="correct-maintain-speed.html" title="forward to "1 Basic Facts of Life"" data-pltdoc="x">next →</a></span> </div><h2 x-source-module="(lib "scribblings/style/style.scrbl")" x-part-tag=""top""><a name="(part._top)"></a><a name="(part._.How_to_.Program_.Racket)"></a><a name="(idx._(gentag._0._(lib._scribblings/style/style..scrbl)))"></a>How to Program Racket</h2><div class="SAuthorListBox"><span class="SAuthorList"><p class="author">Matthias Felleisen, Matthew Flatt, Robby Findler, Jay McCarthy</p></span></div><p>Since 1995 the number of “repository contributors” has grown from a small handful to
three dozen and more. This growth implies a lot of learning
and the introduction of inconsistencies of programming styles. This document
is an attempt leverage the former and to start reducing the latter. Doing so will
help us, the developers, and our users, who use the open source code in
our repository as an implicit guide to Racket programming.</p><p>To help manage the growth our code and showcase good Racket style, we need
guidelines that shape the contributions to the code base. These guidelines should
achieve some level of consistency across the different portions of the
code base so that everyone who opens files can easily find their way
around.</p><p>This document spells out the guidelines. They cover a range of topics, from
basic work (commit) habits to small syntactic ideas like indentation and
naming.</p><p>Many pieces of the code base don’t live up to the guidelines yet. Here is how
we get started. When you start a new file, stick to the guidelines. If you need
to edit a file, you will need to spend some time understanding its
workings. If doing so takes quite a while due to inconsistencies with the
guidelines, please take the time to fix (portions of) the file. After all, if
the inconsistencies throw you off for that much time, others are likely to
have the same problems. If you help fixing it, you reduce future
maintenance time. Whoever touches the file next will be grateful to you.
<span style="font-style: italic">Do</span> run the test suites, and do <span style="font-style: italic">not</span> change the behavior of
the file.</p><p>Also, look over the commit messages. If you see problems with the code
deltas, let the contributor know. If you see a bug fix without docs and
tests, let the contributor know. Code should be viewed by more than one
person because a second person is likely to catch logical mistakes,
performance problems, and unintended effects.</p><p><span style="font-weight: bold">Request</span> This document isn’t complete and it isn’t perfect. Consider
it a call for improvements and suggestions. If you have ideas, contact
the first author via email. If your request gets ignored, appeal to all
four authors.</p><p><span style="font-weight: bold">Note</span> The recommendations in this style guide may not jibe with what
you grew up with. (They conflict with some of the ideas that the primary
author had about style.) But if you do write code that ends up in the
Racket code base, please follow the recommendations here. If/when someone
else works on your code, this person may “fix” your code if it isn’t in
compliance with the style guide.</p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <span class="nonavigation">← prev</span> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">up</a> <a href="correct-maintain-speed.html" title="forward to "1 Basic Facts of Life"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|