Development guidelines

Synopsis

1. fork and clone the project: see lettuce repository at github.com [1]
2. Install a development environment for lettuce
3. run the tests: see Testing
4. hack at will
5. commit, push, etc...
6. send a pull request

Table of contents

• Install a development environment for lettuce
  • OS specific
    • Installation on Debian Squeeze
  • Generic guidelines
    • Dependencies
    • Installing lettuce itself
• Testing
  • Run tests
• Contributing to the documentation
  • Conventions
    • Language
    • Line length
    • Headings
    • Code blocks
    • Links and references
  • Install Sphinx
  • Export documentation to HTML
  • Use doctests!
    • Write doctests
    • Run doctests
  • References

Keep in mind

that lettuce is a testing software, patches and pull requests must come with automated tests, and if suitable, with proper documentation.

References

[1]	https://github.com/gabrielfalcao/lettuce