Avocado Contributor’s Guide

Useful pointers on how to participate of the Avocado community and contribute.

• Brief introduction
• How can I contribute?
  • Report a bug
  • Suggest enhancements
  • Contribute with code
  • Share your tests
  • Documentation
• Development environment
  • Installing dependencies
  • Installing in develop mode
• Style guides
  • Commit style guide
  • Code style guide
• Writing an Avocado plugin
  • Code example
  • Registering configuration options (settings)
  • Registering plugins
  • Namespace
  • Plugin config files
  • Plugins execution order
  • Cacheable plugins
  • New test type plugin example
• The “nrunner” test runner
  • Motivation
  • NRunner components of Avocado
  • Basic Avocado usage and workflow
  • Concepts
  • Runners
  • Runner scripts
  • Runner Execution
  • Trying it out - standalone
  • Writing new runner scripts
  • Runners messages
• Implementing other result formats
• Request for Comments (RFCs)
  • What is a RFC?
  • Submiting a RFC
  • Previous RFCs
• Releasing Avocado
  • Which repositories you should pay attention to
  • How to release?
  • How to refresh Fedora/EPEL modules
• Avocado development tips
  • In tree utils
  • measure_duration
  • Line-profiler
  • Remote debug with Eclipse
• Contact information