092fb2e083
Some checks failed
Lock Threads / action (push) Has been cancelled
Mark stale issues and pull requests / stale (push) Has been cancelled
Publish Chatwoot EE docker images / build (linux/amd64, ubuntu-latest) (push) Has been cancelled
Publish Chatwoot EE docker images / build (linux/arm64, ubuntu-22.04-arm) (push) Has been cancelled
Publish Chatwoot EE docker images / merge (push) Has been cancelled
Publish Chatwoot CE docker images / build (linux/amd64, ubuntu-latest) (push) Has been cancelled
Publish Chatwoot CE docker images / build (linux/arm64, ubuntu-22.04-arm) (push) Has been cancelled
Publish Chatwoot CE docker images / merge (push) Has been cancelled
Run Chatwoot CE spec / lint-backend (push) Has been cancelled
Run Chatwoot CE spec / lint-frontend (push) Has been cancelled
Run Chatwoot CE spec / frontend-tests (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (0, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (1, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (10, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (11, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (12, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (13, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (14, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (15, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (2, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (3, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (4, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (5, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (6, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (7, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (8, 16) (push) Has been cancelled
Run Chatwoot CE spec / backend-tests (9, 16) (push) Has been cancelled
Run Linux nightly installer / nightly (push) Has been cancelled
- Add Logistics component with progress tracking - Add OrderDetail component for order information - Support data-driven steps and actions - Add blue color scale to widget SCSS - Fix node overflow and progress bar rendering issues - Add English translations for dashboard components Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
89 lines
4.6 KiB
Markdown
89 lines
4.6 KiB
Markdown
# Chatwoot Development Guidelines
|
||
|
||
## Build / Test / Lint
|
||
|
||
- **Setup**: `bundle install && pnpm install`
|
||
- **Run Dev**: `pnpm dev` or `overmind start -f ./Procfile.dev`
|
||
- **Lint JS/Vue**: `pnpm eslint` / `pnpm eslint:fix`
|
||
- **Lint Ruby**: `bundle exec rubocop -a`
|
||
- **Test JS**: `pnpm test` or `pnpm test:watch`
|
||
- **Test Ruby**: `bundle exec rspec spec/path/to/file_spec.rb`
|
||
- **Single Test**: `bundle exec rspec spec/path/to/file_spec.rb:LINE_NUMBER`
|
||
- **Run Project**: `overmind start -f Procfile.dev`
|
||
- **Ruby Version**: Manage Ruby via `rbenv` and install the version listed in `.ruby-version` (e.g., `rbenv install $(cat .ruby-version)`)
|
||
- **rbenv setup**: Before running any `bundle` or `rspec` commands, init rbenv in your shell (`eval "$(rbenv init -)"`) so the correct Ruby/Bundler versions are used
|
||
- Always prefer `bundle exec` for Ruby CLI tasks (rspec, rake, rubocop, etc.)
|
||
|
||
## Code Style
|
||
|
||
- **Ruby**: Follow RuboCop rules (150 character max line length)
|
||
- **Vue/JS**: Use ESLint (Airbnb base + Vue 3 recommended)
|
||
- **Vue Components**: Use PascalCase
|
||
- **Events**: Use camelCase
|
||
- **I18n**: No bare strings in templates; use i18n
|
||
- **Error Handling**: Use custom exceptions (`lib/custom_exceptions/`)
|
||
- **Models**: Validate presence/uniqueness, add proper indexes
|
||
- **Type Safety**: Use PropTypes in Vue, strong params in Rails
|
||
- **Naming**: Use clear, descriptive names with consistent casing
|
||
- **Vue API**: Always use Composition API with `<script setup>` at the top
|
||
|
||
## Styling
|
||
|
||
- **Tailwind Only**:
|
||
- Do not write custom CSS
|
||
- Do not use scoped CSS
|
||
- Do not use inline styles
|
||
- Always use Tailwind utility classes
|
||
- **Colors**: Refer to `tailwind.config.js` for color definitions
|
||
|
||
## General Guidelines
|
||
|
||
- MVP focus: Least code change, happy-path only
|
||
- No unnecessary defensive programming
|
||
- Ship the happy path first: limit guards/fallbacks to what production has proven necessary, then iterate
|
||
- Prefer minimal, readable code over elaborate abstractions; clarity beats cleverness
|
||
- Break down complex tasks into small, testable units
|
||
- Iterate after confirmation
|
||
- Avoid writing specs unless explicitly asked
|
||
- Remove dead/unreachable/unused code
|
||
- Don’t write multiple versions or backups for the same logic — pick the best approach and implement it
|
||
- Prefer `with_modified_env` (from spec helpers) over stubbing `ENV` directly in specs
|
||
- Specs in parallel/reloading environments: prefer comparing `error.class.name` over constant class equality when asserting raised errors
|
||
|
||
## Commit Messages
|
||
|
||
- Prefer Conventional Commits: `type(scope): subject` (scope optional)
|
||
- Example: `feat(auth): add user authentication`
|
||
- Don't reference Claude in commit messages
|
||
|
||
## Project-Specific
|
||
|
||
- **Translations**:
|
||
- Only update `en.yml` and `en.json`
|
||
- Other languages are handled by the community
|
||
- Backend i18n → `en.yml`, Frontend i18n → `en.json`
|
||
- **Frontend**:
|
||
- Use `components-next/` for message bubbles (the rest is being deprecated)
|
||
|
||
## Ruby Best Practices
|
||
|
||
- Use compact `module/class` definitions; avoid nested styles
|
||
|
||
## Enterprise Edition Notes
|
||
|
||
- Chatwoot has an Enterprise overlay under `enterprise/` that extends/overrides OSS code.
|
||
- When you add or modify core functionality, always check for corresponding files in `enterprise/` and keep behavior compatible.
|
||
- Follow the Enterprise development practices documented here:
|
||
- https://chatwoot.help/hc/handbook/articles/developing-enterprise-edition-features-38
|
||
|
||
Practical checklist for any change impacting core logic or public APIs
|
||
- Search for related files in both trees before editing (e.g., `rg -n "FooService|ControllerName|ModelName" app enterprise`).
|
||
- If adding new endpoints, services, or models, consider whether Enterprise needs:
|
||
- An override (e.g., `enterprise/app/...`), or
|
||
- An extension point (e.g., `prepend_mod_with`, hooks, configuration) to avoid hard forks.
|
||
- Avoid hardcoding instance- or plan-specific behavior in OSS; prefer configuration, feature flags, or extension points consumed by Enterprise.
|
||
- Keep request/response contracts stable across OSS and Enterprise; update both sets of routes/controllers when introducing new APIs.
|
||
- When renaming/moving shared code, mirror the change in `enterprise/` to prevent drift.
|
||
- Tests: Add Enterprise-specific specs under `spec/enterprise`, mirroring OSS spec layout where applicable.
|
||
- When modifying existing OSS features for Enterprise-only behavior, add an Enterprise module (via `prepend_mod_with`/`include_mod_with`) instead of editing OSS files directly—especially for policies, controllers, and services. For Enterprise-exclusive features, place code directly under `enterprise/`.
|