project-conventions

Provide Java coding conventions based on the Alibaba Java Development Manual.

27|12|Updated May 26, 2020
One-click install
npx skills add https://github.com/wujun728/jun_product_center --skill project-conventions-wujun728
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/wujun728/jun_product_center/tree/main/.claude/skills/project-conventions
Command: npx skills add https://github.com/wujun728/jun_product_center --skill project-conventions-wujun728

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to project coding conventions, ensuring consistency and maintainability across the codebase.

Core Features & Use Cases

  • Coding Standards: Defines naming conventions, package structures, and code formatting.
  • Database Best Practices: Outlines table and field naming, and essential fields.
  • Layered Architecture: Details the responsibilities of each architectural layer (Controller, Service, Repository, DAO).
  • Use Case: A new developer joins the team and needs to understand how to structure their code, name variables, and interact with the database according to established project guidelines.

Quick Start

Refer to the project-conventions skill for detailed guidelines on Java package naming.

Frequently Asked Questions about project-conventions

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

FAQPage Schema
What are the Java coding conventions for package structure and naming?

Java coding conventions for package structure require standardized naming and organization to ensure consistency. This guide provides detailed rules for naming packages, classes, methods, and variables based on the Alibaba Java Development Manual.

How do I handle exceptions and logging in a Java project?

Exception handling and logging practices in Java projects require standardized approaches to ensure maintainability. This guide details proper exception management, utility class usage, and logging standards according to established project guidelines.

What are the database schema design best practices for Java applications?

Database schema design best practices for Java applications involve specific table and field naming conventions alongside essential field requirements. This guide outlines schema design rules to maintain data consistency across projects.

What are the responsibilities of each layer in a Java layered architecture?

Layered architecture responsibilities in Java define specific roles for Controller, Service, Repository, and DAO layers. This guide details the obligations and boundaries of each architectural layer to maintain code structure.

How do I apply Alibaba Java Development Manual rules to my codebase?

Applying Alibaba Java Development Manual rules involves adopting defined coding standards, data type specifications, and coding prohibitions. This guide provides a comprehensive convention framework covering annotations, comments, and formatting to ensure consistency.

Are there specific coding prohibitions for Java methods and variables?

Coding prohibitions for Java methods and variables restrict certain practices to enforce code quality and maintainability. This guide identifies specific coding prohibitions alongside annotation usage and commenting standards to prevent anti-patterns.