work-one/file-one
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
file-one/AGENTS.md
kenneth 6323a3f41c docs: add project guidelines and commit conventions 
- Add AGENTS.md with tech stack, project structure, and code styles
- Add dev/docs/dashboard.md with frontend-specific guidelines
- Include conventional commit types with examples

Co-authored-by: Ona <no-reply@ona.com>
2025-09-21 16:05:39 +00:00

959 B
Raw Permalink Blame History

Project tech stack

frontend: react, shadcn, tailwindcss backend: convex

Project structure

This project uses npm workspaces.

  • packages/convex - convex functions and models
  • packages/web - frontend dashboard
  • packages/path - path utils

General Guidelines

  • For frontend dashboard guidelines, refer to dev/docs/dashboard.md
  • Always use bun for package management and running npm scripts.
  • When commiting, follow conventional commits: [type]: msg and clarify in commit body if necessary. keep your commit header to <= 50 characters.
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation
    • refactor: for code restructuring
    • style: for formatting changes
    • test: for adding tests
    • ci: for CI/CD pipeline changes
    • build: for build system or dependency changes

Code styles

  • file names should always be kebab-case except in convex code, in which case try to use single word file names.