Skip to content

Contributing to WebNR

Thank you for your interest in contributing to WebNR! This guide will help you get started.

Development Setup

  1. Fork and clone the source:
git clone https://github.com/yourusername/webNR.git
cd webNR
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

Project Structure

  • /src - Source code
  • /public - Static assets
  • /docs - Documentation
  • /tests - Test files

Guidelines

Code Style

  • Use TypeScript
  • Follow ESLint configuration
  • Write meaningful commit messages

Pull Requests

  1. Create a new branch for your feature
  2. Make your changes
  3. Write/update tests
  4. Submit a PR with a clear description

Testing

Run tests before submitting:

npm test

Areas to Contribute

  • Bug fixes
  • New features
  • Documentation
  • Translations
  • source sources