/usr/share/doc/racket/unstable/guidelines.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 | <!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>1 Guidelines for Developing unstable Libraries</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.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="index.html" class="tocviewlink" data-pltdoc="x">Unstable:<span class="mywbr"> </span> May Change Without Warning</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="" class="tocviewselflink" data-pltdoc="x">Guidelines for Developing <span class="RktSym">unstable</span> Libraries</a></td></tr><tr><td align="right">2 </td><td><a href="Automata__Compiling_State_Machines.html" class="tocviewlink" data-pltdoc="x">Automata:<span class="mywbr"> </span> Compiling State Machines</a></td></tr><tr><td align="right">3 </td><td><a href="bytes.html" class="tocviewlink" data-pltdoc="x">Bytes</a></td></tr><tr><td align="right">4 </td><td><a href="contract.html" class="tocviewlink" data-pltdoc="x">Contracts</a></td></tr><tr><td align="right">5 </td><td><a href="wrapc.html" class="tocviewlink" data-pltdoc="x">Contracts for Macro Subexpressions</a></td></tr><tr><td align="right">6 </td><td><a href="Debugging.html" class="tocviewlink" data-pltdoc="x">Debugging</a></td></tr><tr><td align="right">7 </td><td><a href="Definitions.html" class="tocviewlink" data-pltdoc="x">Definitions</a></td></tr><tr><td align="right">8 </td><td><a href="error.html" class="tocviewlink" data-pltdoc="x">Errors</a></td></tr><tr><td align="right">9 </td><td><a href="future.html" class="tocviewlink" data-pltdoc="x">Futures</a></td></tr><tr><td align="right">10 </td><td><a href="Functions.html" class="tocviewlink" data-pltdoc="x">Functions</a></td></tr><tr><td align="right">11 </td><td><a href="Hash_Tables.html" class="tocviewlink" data-pltdoc="x">Hash Tables</a></td></tr><tr><td align="right">12 </td><td><a href="class-iop.html" class="tocviewlink" data-pltdoc="x">Interface-<wbr></wbr>Oriented Programming for Classes</a></td></tr><tr><td align="right">13 </td><td><a href="lazy-require.html" class="tocviewlink" data-pltdoc="x">Lazy Require</a></td></tr><tr><td align="right">14 </td><td><a href="list.html" class="tocviewlink" data-pltdoc="x">Lists</a></td></tr><tr><td align="right">15 </td><td><a href="Logging.html" class="tocviewlink" data-pltdoc="x">Logging</a></td></tr><tr><td align="right">16 </td><td><a href="macro-testing.html" class="tocviewlink" data-pltdoc="x">Macro Testing</a></td></tr><tr><td align="right">17 </td><td><a href="Mark_Parameters.html" class="tocviewlink" data-pltdoc="x">Mark Parameters</a></td></tr><tr><td align="right">18 </td><td><a href="match.html" class="tocviewlink" data-pltdoc="x">Match</a></td></tr><tr><td align="right">19 </td><td><a href="open-place.html" class="tocviewlink" data-pltdoc="x">Open <span class="RktSym"><span class="RktStxLink">place</span></span> expressions</a></td></tr><tr><td align="right">20 </td><td><a href="options.html" class="tocviewlink" data-pltdoc="x">Option Contracts</a></td></tr><tr><td align="right">21 </td><td><a href="Parameter_Groups.html" class="tocviewlink" data-pltdoc="x">Parameter Groups</a></td></tr><tr><td align="right">22 </td><td><a href="Pretty-Printing.html" class="tocviewlink" data-pltdoc="x">Pretty-<wbr></wbr>Printing</a></td></tr><tr><td align="right">23 </td><td><a href="recontract.html" class="tocviewlink" data-pltdoc="x">Re-<wbr></wbr>Contracting Identifiers</a></td></tr><tr><td align="right">24 </td><td><a href="sandbox.html" class="tocviewlink" data-pltdoc="x">Sandbox</a></td></tr><tr><td align="right">25 </td><td><a href="sequence.html" class="tocviewlink" data-pltdoc="x">Sequences</a></td></tr><tr><td align="right">26 </td><td><a href="string.html" class="tocviewlink" data-pltdoc="x">Strings</a></td></tr><tr><td align="right">27 </td><td><a href="struct.html" class="tocviewlink" data-pltdoc="x">Structs</a></td></tr><tr><td align="right">28 </td><td><a href="custom-write.html" class="tocviewlink" data-pltdoc="x">Struct Printing</a></td></tr><tr><td align="right">29 </td><td><a href="syntax.html" class="tocviewlink" data-pltdoc="x">Syntax</a></td></tr><tr><td align="right">30 </td><td><a href="temp-c.html" class="tocviewlink" data-pltdoc="x">Temporal Contracts:<span class="mywbr"> </span> Explicit Contract Monitors</a></td></tr><tr><td align="right">31 </td><td><a href="unix-socket.html" class="tocviewlink" data-pltdoc="x">Unix Domain Sockets</a></td></tr><tr><td align="right">32 </td><td><a href="2d.html" class="tocviewlink" data-pltdoc="x">2D Syntax</a></td></tr></table></div></div></div></div><div class="maincolumn"><div class="main"><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"> <a href="index.html" title="backward to "Unstable: May Change Without Warning"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Unstable: May Change Without Warning"" data-pltdoc="x">up</a> <a href="Automata__Compiling_State_Machines.html" title="forward to "2 Automata: Compiling State Machines"" data-pltdoc="x">next →</a></span> </div><h3 x-source-module="(lib "unstable/scribblings/unstable.scrbl")" x-part-tag=""guidelines"">1<tt> </tt><a name="(part._guidelines)"></a>Guidelines for Developing <span class="RktSym">unstable</span> Libraries</h3><p>Any collection developer may add modules to the
<span class="RktSym">unstable</span> collection.</p><p>Every module needs an owner to be responsible for it.</p><ul><li><p>If you add a module, you are its owner. Add a comment with your
name at the top of the module.</p></li><li><p>If you add code to someone else’s module, tag your additions
with your name. The module’s owner may ask you to move your code to a
separate module if they don’t wish to accept responsibility for it.</p></li></ul><p>When changing a library, check all uses of the library in the
collections tree and update them if necessary. Notify users of major
changes.</p><p>Place new modules according to the following rules. (These rules are
necessary for maintaining PLT’s separate text, gui, and drracket
distributions.)</p><ul><li><p>Non-GUI modules go under <span class="stt">unstable</span> (or subcollections
thereof). Put the documentation in <span class="stt">unstable/scribblings</span> and
include with <span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=scribble&rel=base.html%23%2528form._%2528%2528lib._scribble%252Fbase..rkt%2529._include-section%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">include-section</a></span> from
<span class="stt">unstable/scribblings/unstable.scrbl</span>.</p></li><li><p>GUI modules go under <span class="stt">unstable/gui</span>. Put the documentation
in <span class="stt">unstable/scribblings/gui</span> and include them with
<span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=scribble&rel=base.html%23%2528form._%2528%2528lib._scribble%252Fbase..rkt%2529._include-section%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">include-section</a></span> from <span class="stt">unstable/scribblings/gui.scrbl</span>.</p></li><li><p>Do not add modules depending on DrRacket to the
<span class="stt">unstable</span> collection.</p></li><li><p>Put tests in <span class="stt">tests/unstable</span>.</p></li></ul><p>Keep documentation and tests up to date.</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"> <a href="index.html" title="backward to "Unstable: May Change Without Warning"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Unstable: May Change Without Warning"" data-pltdoc="x">up</a> <a href="Automata__Compiling_State_Machines.html" title="forward to "2 Automata: Compiling State Machines"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|