Guides and examples
Contributing
How to contribute to Strata
Contributing to Strata
Thank you for your interest in contributing to Strata!
Getting Started
1. Fork and Clone
# Fork via GitHub UI, then:
git clone https://github.com/YOUR_USERNAME/core.git
cd core
pnpm install2. Create a Branch
git checkout -b feature/my-feature
# or
git checkout -b fix/my-fix3. Make Changes
Follow the coding standards in STANDARDS.md.
4. Test
pnpm test
pnpm lint5. Submit PR
Push your branch and create a pull request.
Repository Structure
| Repository | Purpose |
|---|---|
core | Main library |
shaders | GLSL shaders |
presets | Preset configurations |
examples | Example applications |
react-native | React Native plugin |
capacitor | Capacitor plugin |
jbcom/strata-game-library | Documentation (this site) |
Development Setup
Core Library
cd core
pnpm install
pnpm dev # Watch mode
pnpm test # Run testsDocumentation
cd jbcom/strata-game-library
pnpm install
pnpm dev # Dev server at localhost:4321Code Style
- Use TypeScript strict mode
- Follow existing patterns
- Add JSDoc comments for public APIs
- Write tests for new features
Commit Messages
Use conventional commits:
feat: add new water caustics effect
fix: correct terrain LOD calculation
docs: update water API documentation
test: add vegetation wind testsQuestions?
- Open an issue on GitHub
- Check existing issues and discussions
