Skip to content

Contributing

Ahmed Abdelnaby edited this page Sep 28, 2026 · 1 revision

Contributing

Thanks for your interest in contributing to Radiance! This page outlines how to contribute code, report bugs, and propose enhancements.

Getting the code

  • Fork the repository or work directly in a branch if you have push rights.
  • Create a branch for your work: git checkout -b feat/my-feature

Code style & tests

  • Follow the repository's formatting rules (black/ruff/flake8 or the tools defined in the repo).
  • Run existing unit and integration tests before opening a PR: pytest tests/

Submitting a PR

  1. Fork → branch → commit
  2. Push your branch
  3. Open a Pull Request with:
    • Description of change
    • Reproduction steps (if bug fix)
    • Performance/accuracy notes (if relevant)
  4. Address review comments and re-run tests

Issue reporting

  • Provide a short description, steps to reproduce, environment details (OS, GPU, CUDA version), and minimal repro.

Developer tips

  • Keep changes small and focused for easier review.
  • For complex features, open an issue first to discuss design and approach.

Code of conduct

  • Be respectful and constructive in all communications. Follow the project's Code of Conduct (see repository root for details).

Clone this wiki locally