Game Framework
Best Practices

Naming Conventions

Follow consistent naming conventions for packages and workspaces.

Package Names

Format

Use lowercase with underscores:

# ✓ Good
company_auth
company_ui_components
my_flutter_utils

# ✗ Bad
CompanyAuth  # No camelCase
company-auth  # No hyphens
Auth  # Too generic

Prefixing

Use consistent prefixes:

# Company prefix
acme_auth
acme_ui
acme_analytics

# Team prefix
mobile_auth
mobile_ui

# Feature prefix
payments_stripe
payments_paypal

Workspace Names

# Good workspace names
frontend-team
mobile-engineering
project-alpha

# Bad workspace names
ws1
test
temp

Best Practices

  1. Be descriptive - Clear purpose
  2. Be consistent - Same prefix pattern
  3. Be concise - Short but meaningful
  4. Avoid conflicts - Don't use Flutter SDK names
  5. Document - Explain naming in README

Next Steps