AGENTS.md
1# AGENTS.md
2
3## Setup commands
4
5- Install deps: `bun install`
6- Start dev server: `bun dev`
7- Run tests: `bun test`
8
9## CSS Method
10
11- style tags, attributes, and id's (rarely use classes)
12
13## Git Commits
14
15- Always run `bun format`, `bun lint` and `bun check` before committing.
16- fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
17- feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
18- BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
19- types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
20- footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
21
22## Branch instructions
23
24- Use `git switch`
25- ## Branch Naming Prefixes:
26 - main: The main development branch
27 - feature/ (or feat/): For new features (e.g., feature/add-login-page, feat/add-login-page)
28 - bugfix/ (or fix/): For bug fixes (e.g., bugfix/fix-header-bug, fix/header-bug)
29 - hotfix/: For urgent fixes (e.g., hotfix/security-patch)
30 - release/: For branches preparing a release (e.g., release/v1.2.0)
31 - chore/: For non-code tasks like dependency, docs updates (e.g., chore/update-dependencies)