Instruction file imported from Ralein/Code-Migration-Demo (.github/instructions/conventions.instructions.md). Copyright stays with the author.

Coding Conventions

Name: conventions
Author: Ralein

Style Guides Enforced

Java: Standard Java conventions (no formatter config detected)
JSP: Keep scriptlets minimal; prefer JSTL/EL if added later

Linters / Formatters

Tool	Config	Run command
None detected — confirm with team

Type Checking

Tool	Strict?	Run command
Java compiler	N/A	Eclipse builder or javac

Naming Conventions

Java classes: PascalCase (VehicleDAO, AddVehicleServlet)
Methods/fields: camelCase
Constants: UPPER_SNAKE_CASE
JSP files: lowerCamel or descriptive (addVehicle.jsp, viewVehicles.jsp)
Database: Tables and columns UPPER_SNAKE_CASE (VEHICLE_ID)

Branching

Model: None detected — confirm with team
Branch name format: None detected — confirm with team

Commit Messages

Format: None detected — confirm with team
Examples: Add upon first team-confirmed commits

Pull Request Conventions

Template: None detected — confirm with team
Required checks: None detected — confirm with team
Required reviewers: None detected — confirm with team

Testing Conventions

Test file naming: None detected — confirm with team
Test naming: None detected — confirm with team
Coverage requirements: None detected — confirm with team

Documentation Conventions

Inline doc style: Javadoc for public classes/methods when modified
README required: Keep README.md updated on DB and run modes

"Always Do" Rules

Validate and sanitize user input server-side (not only via HTML attributes)
Update AGENTS.md and dev-context instructions upon adding endpoints or ports

"Never Do" Rules

Do not commit real database passwords or secrets
Do not edit binaries under WEB-INF/lib directly in place

{ "ocm": "1", "id": "ralein-code-migration-demo-conventions-instructions", "kind": "skill", "name": "conventions", "description": "Code style, naming, branching, commit, lint/format/test conventions for this repository. Loaded automatically for every file. Source of truth for how code should be written and reviewed.", "publisher": "Ralein", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Code style, naming, branching, commit, lint/format/test conventions for this repository. Loaded automatically for every file. Source of truth for how code should be written and reviewed." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/Ralein/Code-Migration-Demo", "path": ".github/instructions/conventions.instructions.md", "ref": "c51546201c4ff0dc88d852cf1fd7954a4f5ae7c8", "url": "https://github.com/Ralein/Code-Migration-Demo/blob/c51546201c4ff0dc88d852cf1fd7954a4f5ae7c8/.github/instructions/conventions.instructions.md", "key": "Ralein/Code-Migration-Demo/.github/instructions/conventions.instructions.md" }, "applies_to": "**" }, "instructions": "# Coding Conventions\n\n## Style Guides Enforced\n\n- Java: Standard Java conventions (no formatter config detected)\n- JSP: Keep scriptlets minimal; prefer JSTL/EL if added later\n\n## Linters / Formatters\n\n| Tool | Config | Run command |\n| ----------------------------------- | ------ | ----------- |\n| _None detected — confirm with team_ | | |\n\n## Type Checking\n\n| Tool | Strict? | Run command |\n| ------------- | ------- | ------------------------ |\n| Java compiler | N/A | Eclipse builder or javac |\n\n## Naming Conventions\n\n- ", "cost": { "context_tokens": 486 } }

conventions

About