Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing to Joule Profiler

First off, thank you for considering contributing to Joule Profiler ! We welcome contributions of all kinds: bug reports, documentation improvements, examples, or new features.

By contributing, you agree that your contributions will be licensed under the MIT License.

How to Contribute

1. Reporting Issues

If you find a bug, unexpected behavior, or have a feature request:

  1. Check the GitHub repositoy issues to see if it has already been reported.
  2. Open a new issue with a clear description of:
    • Steps to reproduce (if applicable)
    • Expected behavior
    • Observed behavior
    • Environment (OS, CPU, GPU, Joule Profiler version, etc.)
    • Provide examples

2. Suggesting Improvements

We love feedback on improving the project. You can suggest improvements via:

  • Opening a GitHub issue labeled as enhancement.
  • Sharing examples, documentation updates, or performance suggestions.

3. Code Contributions (Pull Requests)

If you want to contribute code:

  • Make your changes in a branch in your fork.
  • Ensure existing tests pass and add new tests if needed.
  • Update documentation if your changes affect usage or examples.
  • Open a pull request to the main repository.
  • Reference or label related issues clearly in your PR.