Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
131 lines (92 loc) · 4.71 KB

CONTRIBUTING.md

File metadata and controls

131 lines (92 loc) · 4.71 KB
Raw

Contributing

Thank you for your interest in contributing to Lightning 3 Renderer! This project is managed by RDK Management and welcomes contributions from the community.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a feature branch for your changes
  4. Follow the guidelines below
  5. Submit a pull request

Before You Begin

Before RDK accepts your code into the project, you must sign the RDK Contributor License Agreement (CLA). This is a one-time requirement.

Code Contribution Guidelines

Testing Requirements

All code contributions must include appropriate test coverage:

Unit Tests (Vitest)

  • Requirement: Every new feature or bug fix must include unit tests using Vitest

  • Coverage: Aim for meaningful test coverage of your changes (we monitor coverage trends)

  • Location: Tests are co-located with source code using .test.ts extension

  • Running: Execute tests locally before submitting: pnpm test

  • Examples:

    # Run all tests
pnpm test

# Run tests in watch mode during development
pnpm test -- --watch

Visual Regression Tests (VRT)

  • When Required: For any changes affecting visual rendering or behavioral changes to existing components

  • Criteria:

    • Changes to shader code
    • Modifications to rendering pipeline
    • Adjustments to layout or positioning logic
    • Updates to text rendering or font handling
    • Changes to animation behavior
    • Any graphical output modifications

  • How to Add:

    1. Create a test case in examples/tests/ if one doesn't exist
    2. Define snapshots using @snapshot annotation
    3. Run: pnpm test:visual
    4. Include snapshot images in your PR if adding new visual tests
    5. See Visual Regression README for detailed instructions

  • Snapshot Updates:

    • When intentionally changing visual output, update snapshots
    • Include justification in PR description
    • Maintainers review all snapshot changes carefully

Code Quality

  • No console warnings: Your code should not produce console warnings or errors
  • TypeScript: Use strict TypeScript; no any types without good reason
  • Formatting: Follow existing code style; the project uses ESLint
  • Documentation: Add comments for complex logic
  • Browser Compatibility: Remember this targets Chrome v38+; avoid modern-only APIs

Commit Messages

  • Use clear, descriptive commit messages
  • Reference issues when applicable: Fixes #123
  • Keep commits focused on a single feature or bug fix

Pull Request Process

  1. Update Documentation: If adding features, update README or relevant docs

  2. Run Tests: Ensure all tests pass locally

    pnpm test
pnpm test:visual

  3. Create Your PR with a clear title and description

  4. PR Description Should Include:

    • What changes were made and why
    • Links to related issues
    • For VRT changes: brief explanation of visual modifications
    • Any breaking changes (if applicable)
    • BREAKING CHANGE in commit message if needed

  5. Automated Checks:

    • CI runs unit tests automatically
    • Visual regression tests run on all PRs
    • GitHub Actions validates your submission

  6. Code Review:

    • Address feedback from maintainers
    • Re-run tests if making changes
    • All conversations should be resolved before merging

Development Setup

For detailed setup instructions, build commands, and development workflows, see Getting Started.

GitHub Copilot Code Review

All pull requests are automatically reviewed by GitHub Copilot. Copilot will review your code and leave comments with suggestions and feedback, guided by this project's custom Copilot instructions.

Copilot code review is configured via a repository ruleset (not a workflow file). To set it up or modify it:

  1. Go to Settings → Rules → Rulesets
  2. Open the active branch ruleset (or create a new one targeting your default branch)
  3. Under "Branch rules", enable Automatically request Copilot code review
  4. Optionally enable Review new pushes to re-review on each push

Copilot's reviews are informational ("Comment" type) and do not block merging.

Questions or Need Help?

License

By contributing to this project, you agree that your contributions will be licensed under the Apache License 2.0, consistent with the project's license.