this string has no description
0
AGENTS.md
31 lines 1.6 kB view raw view code

AGENTS.md#

Setup commands#

  • Install deps: bun install
  • Start dev server: bun dev
  • Run tests: bun test

CSS Method#

  • style tags, attributes, and id's (rarely use classes)

Git Commits#

  • Always run bun format, bun lint and bun check before committing.
  • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
  • feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
  • 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.
  • 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.
  • footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.

Branch instructions#

  • Use git switch
  • Branch Naming Prefixes:#

    • main: The main development branch
    • feature/ (or feat/): For new features (e.g., feature/add-login-page, feat/add-login-page)
    • bugfix/ (or fix/): For bug fixes (e.g., bugfix/fix-header-bug, fix/header-bug)
    • hotfix/: For urgent fixes (e.g., hotfix/security-patch)
    • release/: For branches preparing a release (e.g., release/v1.2.0)
    • chore/: For non-code tasks like dependency, docs updates (e.g., chore/update-dependencies)