JE-005: Create A Developmentmd

[han4wluc]

Summary

• Added comprehensive DEVELOPMENT.md guide for new developers
• Documented all key conventions and non-obvious architectural choices
• Included getting started instructions, testing guidelines, and common tasks

What's Included

The DEVELOPMENT.md covers:

• Project Overview: High-level understanding of Jempl's purpose and architecture
• Prerequisites: Bun runtime requirement (not Node.js)
• Getting Started: All essential commands for development
• Project Structure: Clear directory layout with explanations
• JavaScript Conventions:
  • ESM module usage with .js extensions
  • Functional programming approach (no classes)
  • JSDoc for type annotations instead of TypeScript
  • Custom error handling patterns
  • Prettier code formatting rules
• Testing Setup: Vitest + Puty YAML specifications
• Performance Guidelines: Understanding the optimization tiers
• Non-Obvious Design Choices:
  • Two-phase processing (Parse + Render)
  • Zero dependencies philosophy
  • Backward compatibility approach
  • Special syntax decisions
  • Error message philosophy
• Contributing Guidelines: Performance-first approach
• Common Development Tasks: How to add functions, optimize patterns, etc.

Test Plan

• Verified all commands work with Bun
• Checked code examples follow actual codebase patterns
• Ensured documentation aligns with existing conventions
• Cross-referenced with package.json scripts
• Validated against .prettierrc.yaml settings