Something went wrong. Try again.
This string has no description
Something went wrong. Try again.
3.1 kB · 107 lines · Created 10mo ago
Markdown
Project instructions #
Overview #
Web project. Astro 7, TypeScript
Commands #
- Dev:
bun run dev - Build:
bun run build - Format:
bun run format - Lint:
bun run lint - Check:
bun run check
Common subcommands #
dev and preview accept the following to manage a background server:
- stop
- status
- logs
Code #
- Application code lives in
src/. - Generated files live in
dist/. Do not edit them.
Before finishing #
- Run
bun check.
Safety #
- Never print or commit secrets.
- Ask before adding a production dependency.
Scope #
In scope: src/, public/, astro.config.mjs Out of scope: Do not add SSR adapters unless asked. Keep deploy static.
Code Style #
- Write styles for html elements whenever possible before writing styles into an id and lastly before creating a class
Git Commits #
- Always run scripts:
format,lintandcheckbefore committing.
Type #
- fix: a bug fix
- feat: a new feature
- build: build system or external dependencies
- chore: other changes that don't modify src or test files
- ci: ci configuration and scripts
- docs: documentation only
- style: formatting, missing simicolons - no code changes
- refactor: code changes that neither fixes a bug nor adds a feature
- perf: perfomance improvement
- test: adding or fixing tests
- revert: reverts a previous commit
Scope (optional) #
Example: api, auth, deps Noun in paratheses(parentheses: feat(api): …)
Description #
Example: add user signup endpoint Imperative, lowercase, no period — what this commit does.
Body (optional) #
Why this change was needed
Breaking change #
Adds ! after scope and BREAKING CHANGE footer when described. Example: API response shape changed
Issue Refs (optional) #
Example: 42 #99 Closes #42, #99 — appended as footer lines.
Git Branch #
- Use
git switch
Types #
- 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)
Documentation #
Full documentation: https://docs.astro.build
Consult these guides before working on related tasks: