coding-standards

Enforce OFBiz coding standards for Java, Groovy, and service conventions.

175|216|Updated Mar 5, 2017
One-click install
npx skills add https://github.com/apache/ofbiz-plugins --skill coding-standards-apache
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding-standards
Source: https://github.com/apache/ofbiz-plugins/tree/main/ai-agent-skills/coding-standards
Command: npx skills add https://github.com/apache/ofbiz-plugins --skill coding-standards-apache

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures all code contributions to OFBiz adhere to established standards, promoting clarity, maintainability, and architectural consistency across the project.

Core Features & Use Cases

  • Code Quality Enforcement: Provides clear guidelines on commenting, naming conventions, and code structure.
  • OFBiz Best Practices: Details specific standards for XML actions, service definitions, and utility library usage within the OFBiz framework.
  • Use Case: Before submitting a pull request for a new feature, consult this Skill to ensure your Java code follows OFBiz naming conventions and includes necessary Javadoc comments.

Quick Start

Review the coding-standards skill to ensure your new Java code follows OFBiz conventions.

Frequently Asked Questions about coding-standards

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the OFBiz coding standards for Java and Groovy contributions?

OFBiz coding standards mandate production-quality rules for Java and Groovy contributions, covering component naming, entity conventions, and service definitions. They ensure architectural consistency and maintainability across the project.

How do I use OFBiz utility libraries for list creation and validation?

To use OFBiz utility libraries for validation, map creation, and date-effective entity filtering, follow the mandated standards for service definitions and utility library usage. This ensures your code adheres to framework best practices.

What naming conventions should I follow for OFBiz components and services?

OFBiz naming conventions require specific standards for component naming, entity definitions, and service conventions. These rules promote professionalism and clarity, ensuring your pull request meets project architectural requirements.

Do I need to include Javadoc comments for OFBiz service definitions?

Yes, Javadoc comments are required for OFBiz service definitions and code documentation. The coding standards explicitly mandate documentation requirements to ensure your contributions maintain clarity and professional quality.

How do I ensure my OFBiz code passes review before a pull request?

To ensure your OFBiz code passes review, verify it follows coding standards for commenting, cleanliness, and professionalism. Check that your Java and Groovy code uses OFBiz utility libraries for validation and logging.