Skip to content

Latest commit

 

History

History
153 lines (106 loc) · 6.25 KB

CONTRIBUTING.md

File metadata and controls

153 lines (106 loc) · 6.25 KB
Raw

Contributing to Holoscan Sensor Bridge

Table of Contents

Introduction

Welcome to Holoscan Sensor Bridge! Please read our README document for an overview of the project.

Please read this guide if you are interested in contributing open source code to Holoscan Sensor Bridge.

Types of Contributions

Before getting started, assess how your idea or project may best benefit the Holoscan community.

If your code is:

  • feature-complete and tested: Submit a pull request to contribute your work to Holoscan Sensor Bridge.
  • a work in progress: We recommend to fork Holoscan Sensor Bridge and track your local development there, then submit to Holoscan Sensor Bridge when ready. Alternatively, open pull request and indicate that it is a "work-in-progress" with the prefix "WIP".
  • a patch for an existing application or operator: Submit a pull request and request a review from the original author of the contribution you are patching.

We recommend referring to contributing guidelines for testing and styling goals throughout your development process.

Developer Workflow

Requirements

We recommend that new developers review GitHub's starting documentation before making their first contribution.

Workflow

  1. Developers must first fork the [upstream](https://github.com/nvidia-holoscan/holoscan-sensor-bridge) Holoscan Sensor Bridge repository.

  2. Git clone the forked repository and push changes to the personal fork.

    git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git
# Checkout the targeted branch and commit changes
# Push the commits to a branch on the fork (remote).
git push -u origin <local-branch>:<remote-branch>

  3. All code submissions must be formatted according to the rules in ci/lint.sh. You can run ci/lint.sh --format to automatically format all C++, Python, and Markdown files-- usually that's enough to get ci/lint.sh to pass.

  4. Once the code changes are staged on the fork and ready for review, please submit a Pull Request (PR) to merge the changes from a branch of the fork into a selected branch of upstream.

    • Exercise caution when selecting the source and target branches for the PR.
    • Creation of a PR creation kicks off the code review process.

  5. Holoscan Sensor Bridge maintainers will review the PR and accept the proposal if changes meet Holoscan Sensor Bridge standards.

Thanks in advance for your patience as we review your contributions. We do appreciate them!

License Guidelines

  • Make sure that you can contribute your work to open source. Verify that no license and/or patent conflict is introduced by your code. NVIDIA is not responsible for conflicts resulting from community contributions.

  • We encourage community submissions under the Apache 2.0 permissive open source license, which is the Holoscan Sensor Bridge License.

  • We require that members sign their contributions to certify their work.

Coding Guidelines

  • All source code contributions must strictly adhere to the Holoscan Sensor Bridge coding style.

Signing Your Contribution

  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.

  • Any contribution which contains commits that are not Signed-Off will not be accepted.

  • To sign off on a commit you simply use the --signoff (or -s) option when committing your changes:

    $ git commit -s -m "Add cool feature."

    This will append the following to your commit message:

    Signed-off-by: Your Name <[email protected]>

  • Full text of the DCO:

      Developer Certificate of Origin
  Version 1.1
  
  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
  1 Letterman Drive
  Suite D4700
  San Francisco, CA, 94129
  
  Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

      Developer's Certificate of Origin 1.1
  
  By making a contribution to this project, I certify that:
  
  (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
  
  (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
  
  (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
  
  (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Reporting issues

Please open a Holoscan Sensor Bridge Issue Request to request an enhancement, bug fix, or other change in Holoscan Sensor Bridge.