1 Guidelines for developing unstable libraries

▼ |  | Unstable

1 | Guidelines for developing unstable libraries
2 | Bytes
3 | Classes and Objects
4 | Contracts
5 | Definitions
6 | Dictionaries
7 | Directories
8 | Exceptions
9 | Filesystem
10 | Functions
11 | Lists
12 | Net
13 | Path
14 | PLane T Packages
15 | Ports
16 | Pretty-Printing
17 | Regular Expressions
18 | Requiring Modules
19 | Sandboxed Evaluation
20 | Scribble Documentation
21 | Sets
22 | S-Expression Diff
23 | Source Locations
24 | Strings
25 | Structs
26 | Syntax
27 | Planet Package Macros
28 | Text Representations
29 | Multiple Values
30 | XML and CSS
31 | Polymorphic Contracts
32 | Finding Mutated Variables
33 | Find
34 | Interface-Oriented Programming for Classes
35 | Sequences
36 | Hash Tables
37 | Match
38 | Generics
39 | Mark Parameters
40 | Debugging
41 | Contracts for macro subexpressions
42 | GUI libraries

top← prev up next →

### 1`` Guidelines for developing unstable libraries

Any collection developer may add modules to the unstable collection.

Every module needs an owner to be responsible for it.

- If you add a module, you are its owner. Add a comment with your name at the top of the module.

- 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.

When changing a library, check all uses of the library in the collections tree and update them if necessary. Notify users of major changes.

Place new modules according to the following rules. (These rules are necessary for maintaining PLT’s separate text, gui, and drracket distributions.)

- Non-GUI modules go under unstable (or subcollections thereof). Put the documentation in unstable/scribblings and include with include-section from unstable/scribblings/unstable.scrbl.

- GUI modules go under unstable/gui. Put the documentation in unstable/scribblings/gui and include them with include-section from unstable/scribblings/gui.scrbl.

- Do not add modules depending on DrRacket to the unstable collection.

- Put tests in tests/unstable.

Keep documentation and tests up to date.

top← prev up next →