<aside> 💡 Purpose: This document defines a set of rules, conventions, and best practices to maintain clean, consistent, and professional source code & development flow that we could use on our projects or team/company.

Return to mrtin.dev

</aside>

🔷 1. PRE-DEVELOPMENT

1.1. Naming Conventions

Quick note: Standardize how variables, functions, classes, files, database tables, and APIs are named to improve readability and predictability.

Key Points:

• Use camelCase for variables and functions.
• Use PascalCase for classes and components.
• Use UPPER_SNAKE_CASE for constants.
• REST API endpoints use kebab-case and plural nouns (e.g., /api/v1/users).
• Database tables use snake_case.

1.2. Language / Framework Guidelines

Quick note: a common set of frameworks, libraries, and language versions used across projects to ensure consistency and maintainability.

Key Points:

• Always use latest LTS version for Language/SDK/Frameworks (example: Java 21, Next.js (React 18+,…)
• Avoid mixing different frameworks or redundant libraries.
• Prefer widely-supported, community-backed libraries.

1.3. Brainstorming Process

Quick note: how business requirements are gathered, brainstormed, and converted into actionable tasks?