farm_contrib_template

Template for farmOS contrib modules.

This module is an add-on for the farmOS distribution.

This repository can be used as a template for starting new farmOS contrib modules. It provides the following:

• Standardized README.md template
• Example module structure.
• Github action for automated tests:
  • PHPCS and PHPUnit

Getting started

Configuration

Document any special configuration the module requires:

• API keys
• Additional settings options
• External (client) configuration

Features

Document features the module provides:

• Entities and bundles
  • Asset types
  • Log types
  • Taxonomies
• Quick forms
• Field modules
• Special logic

FAQ

Maintainers

Current maintainers:

• Full name (handle) - profile

Sponsors

This project has been sponsored by:

• Organization