Skip to content
Strata

Contributing

Contributing to Strata

Section titled “Contributing to Strata”

Thank you for your interest in contributing to Strata!

Getting Started

Section titled “Getting Started”

1. Fork and Clone

Section titled “1. Fork and Clone”
Terminal window
# Fork via GitHub UI, then:
git clone https://github.com/YOUR_USERNAME/core.git
cd core
pnpm install

2. Create a Branch

Section titled “2. Create a Branch”
Terminal window
git checkout -b feature/my-feature
# or
git checkout -b fix/my-fix

3. Make Changes

Section titled “3. Make Changes”

Follow the coding standards in STANDARDS.md.

4. Test

Section titled “4. Test”
Terminal window
pnpm test
pnpm lint

5. Submit PR

Section titled “5. Submit PR”

Push your branch and create a pull request.

Repository Structure

Section titled “Repository Structure”
RepositoryPurpose
coreMain library
shadersGLSL shaders
presetsPreset configurations
examplesExample applications
react-native-pluginReact Native plugin
capacitor-pluginCapacitor plugin
strata-game-library.github.ioDocumentation (this site)

Development Setup

Section titled “Development Setup”

Core Library

Section titled “Core Library”
Terminal window
cd core
pnpm install
pnpm dev  # Watch mode
pnpm test # Run tests

Documentation

Section titled “Documentation”
Terminal window
cd strata-game-library.github.io
pnpm install
pnpm dev  # Dev server at localhost:4321

Code Style

Section titled “Code Style”
  • Use TypeScript strict mode
  • Follow existing patterns
  • Add JSDoc comments for public APIs
  • Write tests for new features

Commit Messages

Section titled “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 tests

Questions?

Section titled “Questions?”
  • Open an issue on GitHub
  • Check existing issues and discussions
Section titled “Related”