Contributing Guide

How to contribute to the WebGPU Particle Fluid Simulation project.

What belongs here

Prefer changes that:

• improve correctness or stability,
• simplify the codebase or docs,
• improve performance or project presentation,
• reduce maintenance burden.

Avoid broad feature expansion unless it clearly pays for itself.

Workflow

1. Fork and clone the repository.
2. Create a focused branch.
3. Make coherent changes.
4. Run npm run verify.
5. Open a pull request with a clear summary.

Local Setup

git clone https://github.com/YOUR_USERNAME/particle-fluid-sim.git
cd particle-fluid-sim
npm install

Validation Gate

Run the full quality gate before high-impact changes land:

npm run verify

That includes:

npm run lint
npm run typecheck
npm run test:coverage
npm run build

Documentation Rules

• Keep docs aligned with the actual project structure.
• Remove duplicate or stale pages instead of layering more explanation on top.
• Keep GitHub Pages focused on docs plus the live demo.
• Keep the root CHANGELOG.md as the only changelog.

Pull Request Checklist

• [ ] Code compiles (npm run typecheck)
• [ ] Lint passes (npm run lint)
• [ ] Tests pass (npm run test:coverage)
• [ ] Build succeeds (npm run build)
• [ ] Documentation was updated if behavior or structure changed

Getting Help

• Issues: GitHub Issues
• Discussions: GitHub Discussions