Imported from OsomePteLtd/principles (
AGENTS.md). Install upstream withnpx skills add OsomePteLtd/principles. Copyright stays with the author.
AGENTS.md
Repository Overview
Name: principles
Type: Documentation / Guidelines
Description: Osome development principles and coding standards for backend, frontend, testing, and git conventions
Content Structure
principles/
├── README.md # Overview and navigation
├── general/ # General development principles
├── api-spec/ # API specification standards
├── architecture/ # Architecture principles
├── backend/ # Backend development guidelines
├── frontend/ # Frontend development guidelines
├── testing/ # Testing principles
├── git/ # Git conventions
├── checklists/ # Compliance checklists
└── samples/ # Code samples
Topics Covered
General Development
- PR best practices
- Naming conventions
- Clean code principles
- Repository settings
API Spec Development
- TinySpec conventions
- CRUD endpoint patterns
- API versioning
Architecture
- Microservices guidelines
- Service communication patterns
- Event-driven architecture
Backend Development
- Database design and migrations
- Models and controllers
- Services and jobs
- Event bus patterns
- Testing strategies
- Microservices patterns
- Internationalization
Frontend Development
- Project structure
- Module Federation
- TypeScript best practices
- SDK usage
- Unit testing
- Styling conventions
- UI-kit usage
- TanStack Query patterns
- Internationalization
Testing Principles
- Testing trophy strategy
- Integration vs unit tests
- E2E testing
- Mocking strategies
- Playwright selectors
Git Conventions
- Branch naming
- Commit messages
- PR titles
- Conventional commits
Checklists
- Backend best practices compliance
- Service audit checklists
Usage
Reference this documentation when:
- Starting a new project
- Onboarding new developers
- Reviewing code
- Making architectural decisions
Notes for AI Assistants
- This is documentation only - no code to run
- Reference these principles when writing code
- Follow naming and structure conventions
- Use checklists for compliance verification
- Code samples provide reference implementations
- Keep documentation up to date with practices
