Skip to content

Commit 539fc05

Browse files
authored
Merge branch 'main' into update_view_components
2 parents 8c82d4d + bee59aa commit 539fc05

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

AGENT.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Agent Guide
2+
3+
Essence is a Rails 8 engine that ships Beyond UI as ViewComponents with Stimulus/Turbo; Lookbook preview lives in `site/`.
4+
5+
Stack quickref
6+
- Ruby >= 3.3 with Bundler
7+
- ViewComponent + SimpleForm; importmap + Propshaft assets; Stimulus controllers in `app/javascript/essence/controllers`
8+
- Components in `app/components/essence`; styles/images under `app/assets/essence`
9+
10+
Setup
11+
- `bundle install`
12+
- Preview app: `cd site && bin/setup --skip-server` to install deps and prep the sqlite DB
13+
- Start Lookbook: `cd site && bin/rails server` (or run `site/bin/setup` without `--skip-server` to boot via `bin/dev`)
14+
15+
Everyday dev
16+
- Subclass `Essence::ApplicationComponent`; pair `*_component.rb` with `*_component.html.erb`
17+
- JS entry: `app/javascript/essence/application.js`; register controllers via `controllers/index.js`; add importmap pins in `config/importmap.rb` when needed
18+
- CSS/design tokens in `app/assets/stylesheets/essence`; images in `app/assets/images/essence`
19+
- Previews/examples live in `site/app/previews/**`; mirror new props and states there
20+
- Shared helpers and form inputs are under `app/helpers` and `app/inputs`; reuse existing utilities before adding new ones
21+
22+
Quality gates
23+
- Specs: `bundle exec rspec`
24+
- Lint: `bundle exec rubocop`
25+
- Security: `bundle exec brakeman`
26+
- Gem sanity: `bundle exec rake build` (bundler gem tasks)
27+
28+
Notes for changes
29+
- Keep HTML semantics and ARIA intact; components are consumed by storefront apps
30+
- Avoid bundling external JS/CSS; rely on importmap + Stimulus
31+
- Preserve backward compatibility; prefer deprecations to breaking changes
32+
- Update previews and documentation when behaviour or UI shifts

0 commit comments

Comments
 (0)