LizardFS Developers Guide

A guide for people wanting to work on developing LizardFS.

Developers and users can contribute to the LizardFS development in many ways and everyone is welcome in the project.

Users can, for instance, help the development by testing beta releases of the software, reporting and testing of bugs, writing documentation, translate man pages and documentation to your native language, spreading the word and promote LizardFS. In this guide we will be concentrating in helping people wanting to help with the development and documentation of LizardFS.

Contents:

• Obtaining and installing LizardFS from Source
  • Installing LizardFS from source
• Setting up a development workspace
  • General
  • On Linux
  • On Mac OS/X
  • On FreeBSD
• LizardFS functional testing
  • How to set up a testing environment?
  • How to compile the tests?
  • How to launch the tests?
  • How to make your own test?
• Participation Rules
• Submitting Patches
• Repository rules
  • Commit messages
  • Code review process
  • Use of Code-Review and Verified
  • Updating a patch
  • Closing issues with commits
  • Other rules
• Versioning and Release Engineering
  • Versioning
  • Release Engineering
  • Release Cycles
• Dummy-Bughunt
• Documentation-HowTo
  • Editorial Workflow
  • ToDo notes
  • Styleguide / Organizing Files
  • Writing style
  • Installing the documenters Tools on different Platforms
  • Build-Process
  • Submitting your work
• Ressources
  • General
  • Admin specific
  • Developer Specific
  • Third Party AddOns
  • Packages from the community