Skip to content

Conversation

@devlasbe
Copy link
Owner

Summary

This PR adds comprehensive documentation for the Open Franchise project, including Claude agent guides, coding rules, command references, and skill documentation. These documents establish clear workflows, coding standards, and best practices for the development team.

Key Changes

Agent Guides

  • planner.md: Architecture planning agent that analyzes requirements and designs implementation plans
  • code-expert.md: TypeScript coding specialist with NestJS/Next.js expertise
  • code-reviewer.md: Code quality reviewer that performs automated improvements and validation

Coding Rules & Standards

  • nestjs.md: NestJS-specific rules (DTO requirements, module structure, exception handling)
  • nextjs.md: Next.js-specific rules (Server/Client components, styling, data fetching)
  • lint.md: ESLint and Prettier configuration standards
  • git.md: Git commit message conventions and branching strategy

Command References

  • dev.md: Development server execution
  • build.md: Production build process
  • db.md: Prisma database management commands
  • lint.md: Code quality checking and formatting
  • test.md: Test execution (Playwright E2E, Jest)
  • swagger.md: Swagger API documentation guide
  • api-types.md: TypeScript type generation from Swagger

Skill Documentation

  • dto.md: DTO writing guide with templates and TypeUtil usage
  • new-module.md: NestJS module creation guide
  • new-component.md: Next.js component creation guide

Configuration

  • Updated .claude/settings.local.json with expanded Bash permissions for development workflows

Notable Implementation Details

  • Workflow Definition: Established clear agent workflow (planner → code-expert → code-reviewer)
  • DTO Standards: Comprehensive templates using TypeUtil for consistent response formatting
  • Code Quality: Automated lint validation and code review process
  • Documentation: Detailed examples and checklists for common development tasks
  • Naming Conventions: Clear DTO naming patterns (GetXxxReq, GetXxxRes, etc.)

Benefits

  • Standardized development practices across the team
  • Clear guidelines for both backend (NestJS) and frontend (Next.js) development
  • Automated code quality checks and improvements
  • Comprehensive onboarding documentation for new team members
  • Consistent API documentation through Swagger integration

- Fix agent tools: change Shell to Bash in code-expert and code-reviewer
- Add frontmatter description to all command files for slash commands
- Expand settings.local.json permissions for development workflows
- Remove duplicate AGENTS.md files (consolidated into CLAUDE.md)

https://claude.ai/code/session_01Ao3D3rLSAxxHV26R5XtVbp
@vercel
Copy link

vercel bot commented Jan 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
open-franchise-web Ready Ready Preview, Comment Jan 23, 2026 2:37pm

@devlasbe devlasbe changed the base branch from main to develop January 23, 2026 14:37
@devlasbe devlasbe merged commit 6bd8602 into develop Jan 23, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants