Contributing

Thank you for your interest in contributing to Bklit Analytics!

Getting Started

1. Fork the repository
2. Clone your fork
3. Install dependencies: pnpm install
4. Set up environment variables
5. Run development server: pnpm dev

Development Setup

For detailed local development setup including databases, see Local Development.

Code Style

TypeScript

• Use TypeScript for all code
• Enable strict mode
• Use interfaces for types
• Avoid any types

React

• Prefer server components
• Use client components only when needed
• Follow React best practices
• Use hooks appropriately

Formatting

Run formatting before committing:

pnpm format-and-lint:fix

Pull Request Process

1. Create a feature branch
2. Make your changes
3. Write/update tests if applicable
4. Update documentation
5. Run type checking: pnpm typecheck
6. Run linting: pnpm format-and-lint
7. Submit pull request

Commit Messages

Use clear, descriptive commit messages:

feat: Add new analytics feature
fix: Fix token validation bug
docs: Update installation guide

Testing

• Test your changes locally
• Verify all apps still work
• Check for TypeScript errors
• Test edge cases

Documentation

• Update relevant documentation
• Add code comments where needed
• Update README if needed
• Keep docs in sync with code

Questions?

• Open an issue for questions
• Check existing issues first
• Be respectful and helpful

Related Documentation

• Getting Started - Setup guide
• Local Development - Local development setup