Skip to content
Brian Anderson edited this page Apr 16, 2013 · 29 revisions

Module editing plan template

1. Announcement to mailing list

  • Proposed editor: your name
  • Date proposed: date of proposal
  • Link: link to email

Notes from discussion on mailing list

  • There are some

2. Research of standards and techniques

  1. Standard: standard - link to docs - ...

Summary of research on standards and leading techniques

Relevant standards and techniques exist?

Those intended to follow (and why)

Those intended to ignore (and why)

3. Research of libraries from other languages

Summary of research from other languages:

Structures and functions commonly appearing

Types of I/O sources and sinks
  • File
  • TCP socket
  • Unix domain socket
  • Pipe
  • UDP
  • Memory buffer
  • String
  • Formatting + formatted values
  • Serialization
IO adaptors / filters / converters
  • Pattern matching and replacement
  • Character encodings
  • Compression
  • Encryption

Variations on implementation seen

Pitfalls and hazards associated with each variant

Relationship to other libraries and/or abstract interfaces

4. Module writing

  • Pull request: link to bug

Additional implementation notes

  • note
  • note
  • note

All Categories:

Clone this wiki locally