Contributing

​

Getting Started

1. Fork the repository
2. Clone your fork:
   git clone https://github.com/PunGrumpy/logixlysia.git
   cd logixlysia
   
3. Install dependencies:
   bun install
   

​

Development

• Bun as the runtime
• TypeScript for type safety
• ElysiaJS as the web framework

​

Project Structure

apps/
├── docs/          # Documentation site (Blume)
└── elysia/        # Playground demo (Bun + TypeScript + Swagger)
packages/
├── logixlysia/    # The main Logixlysia package
├── bench/         # Benchmarks
└── typescript-config/

src/
├── config/        # Configuration resolution and presets
├── context/       # Request context handling
├── extensions/    # Additional features and extensions
├── helpers/       # Utility functions
├── logger/        # Core logging functionality
├── middleware/    # Elysia middleware/plugin hooks
├── output/        # Output handlers and formatters (console, file, rotation)
├── types/         # TypeScript types
├── utils/         # Shared utilities
├── websocket/     # WebSocket support
├── ai.ts          # AI-related helpers
├── errors.ts      # Structured error handling
├── index.ts       # Main entry point
├── interfaces.ts  # TypeScript interfaces
└── otel.ts        # OpenTelemetry integration

​

Running Tests

bun test

bun test --watch

​

Code Style

• Follow TypeScript best practices
• Use meaningful variable and function names
• Add JSDoc comments for public APIs
• Keep functions small and focused

​

Changesets

1. Run bun changeset in the repository root
2. Select the packages you’ve changed
3. Choose the appropriate version bump (patch, minor, or major)
4. Write a clear description of your changes — it will appear in the changelog
5. Commit the generated file in .changeset/ along with your changes

​

Pull Request Process

1. Create a new branch for your feature/fix
2. Make your changes
3. Run tests and ensure they pass
4. Update documentation if needed
5. Submit a pull request with a clear description

​

PR Checklist

• Tests added/updated
• Documentation updated
• Code follows style guidelines
• Changes are backward compatible

​

Questions?