Contributing
How to run tests, add new providers, and contribute to Logixlysia.
Thank you for your interest in contributing to Logixlysia! This guide will help you get started with development, testing, and adding new providers.
Getting Started
To get started with Logixlysia development, follow these steps:
Fork the repository
Clone your fork
Install dependencies
Development Setup
Logixlysia is built with:
- Bun as the runtime
- TypeScript for type safety
- ElysiaJS as the web framework
Project Structure
Running Tests
To run the test suite:
For watching tests during development:
Adding New Features
Adding a New Provider
- Create a new file in the
src/providers
directory - Implement the provider interface
- Add tests for your provider
- Update the documentation
Code Style
- Follow TypeScript best practices
- Use meaningful variable and function names
- Add JSDoc comments for public APIs
- Keep functions small and focused
Pull Request Process
- Create a new branch for your feature/fix
- Make your changes
- Run tests and ensure they pass
- Update documentation if needed
- Submit a pull request with a clear description
PR Checklist
- Tests added/updated
- Documentation updated
- Code follows style guidelines
- Changes are backward compatible
Documentation
Documentation is written in MDX and located in the website/content/docs
directory. When adding new features:
- Add relevant documentation
- Include code examples
- Update the API reference if needed
Questions?
Feel free to open an issue if you have any questions or need help getting started. We're happy to help!