Call Us Today! 877.742.2583




Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Moved the "new module checklist" to the new "New Modules" page

...

Code Block
--[[
All of this
Is commented
]]

New Module Checklist

When proposing a new module:

  • Add a Makefile.am for the module

  • Add the module to the FS configure.ac

  • Add the module to build/modules.conf.in (commented out)

  • Describe the module in as much detail as possible in the comments at the top of the module

  • Add our whitespace footer to the module files; ensure the \*.[ch] module files use tabs for indentation and are free of trailing whitespace (eg. in Emacs, run `M-x whitespace-mode`, then `M-x whitespace-cleanup`)

  • Remove any unused code left over from debugging

  • Ensure symbols not meant to be exported are declared static

  • Don't add any files to conf/vanilla

  • Write a commit message body describing the module, why it's useful, what it does, how it works, and any parts not yet implemented