Welcome to Holoscan SDK! We're glad that you're considering contributing to the platform.
Holoscan SDK is released on GitHub as open source software to better support the community and facilitate feedback. By contributing you agree to follow our code of conduct.
Community feedback helps us improve the Holoscan SDK platform to better meet user needs. We use GitHub Issues to track feedback and problems over time, as well as to provide limited support to Holoscan SDK users.
Consider reviewing existing issues or opening a new issue if you:
- Have a question about using a Holoscan SDK feature
- Notice errors or unexpected behavior coming from Holoscan SDK
- Have an idea for a change that might benefit other users
When reporting an error, please include relevant details that will help our team investigate the issue. Details might include:
- A summary of the problem
- The behavior you have observed
- The behavior you expected
- Details about your PC, including the architecture (x86_64 or arm64) and GPU
- The version of Holoscan SDK where you observed the problem
- Any relevant logs or images to help investigate the issue
You can also refer to the Holoscan SDK NVIDIA Developer Forums for support questions and community discussions.
Users are welcome to suggest code changes to Holoscan SDK in the form of Issues or Pull Requests.
Please open a new issue if you'd like to request a new feature or propose a feature design. You can tag a specific community maintainer in your post with "@", or we'll update when we've had a chance to review your post.
While we primarily develop Holoscan SDK internally, we also accept external contributions that help move the platform forward. We typically favor contributions that aim to fix an existing issue or improve documentation, but we'll also integrate new features and enhancements when they're aligned with the Holoscan SDK vision. Please check in with the development team to propose your idea before spending time working on new features. This will help prevent duplicate effort and avoid spending time on features that would be unlikely to be merged. We'll typically refer new operators for contribution to the downstream HoloHub community project.
You might contribute to Holoscan to help us address fixes earlier in our development cycle, or to suggest improvements to Holoscan SDK that you believe would broadly benefit the Holoscan community.
Holoscan SDK follows a monthly release process that includes internal quality assurance. To add a fix or feature, we request that you fork Holoscan SDK, develop in a branch, and submit your change as a pull request against the latest Holoscan SDK release commit. If we accept your submission after external discussion, we will integrate those changes within our internal development and credit you in Git commit history. Any changes that we accept from community contributions will undergo quality assurance testing before they are included in the next Holoscan SDK release.
Note: We recommend that new GitHub users read GitHub's Getting Started guide before opening their first pull request.
We take all community feedback into consideration. If we don't believe a proposed change aligns with our direction for Holoscan SDK, or if we don't expect we can prioritize a task within a reasonable timeframe, we'll let you know by appropriately labeling or closing the issue or pull request with an explanatory comment.
For items that we do plan to pursue or integrate, we use GitHub Milestones to communicate our release planning. We will add community issues and pull requests to the approximate monthly release milestone when we expect to pursue that development. Issues that we mark as "needs triage" are not part of a milestone and will be revisited once each month to determine our priorities.
Please refer to the project README document for additional developer information. Happy coding!