forked from nvidia-holoscan/holohub
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
BasedOnStyle: Google | ||
ColumnLimit: 100 | ||
AllowShortBlocksOnASingleLine: Always | ||
AllowShortFunctionsOnASingleLine: Inline | ||
AllowShortIfStatementsOnASingleLine: Always | ||
AllowShortLambdasOnASingleLine: All | ||
AllowShortLoopsOnASingleLine: true | ||
|
||
# Google style doesn't specify a pointer and reference whitespace alignment: it allows both but | ||
# recommends consistency. We chose to enforce the style for pointers and references to be on the | ||
# left, that is to the type, with a whitespace after. | ||
DerivePointerAlignment: false | ||
PointerAlignment: Left | ||
|
||
IncludeBlocks: Preserve | ||
|
||
# One parameter per line | ||
BinPackArguments: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
|
||
## HoloHub Contribution Rules | ||
|
||
#### Issue Tracking | ||
|
||
* All enhancement, bugfix, or change requests must begin with the creation of a [HoloHub Issue Request](https://github.com/nvidia-holoscan/holohub/issues). | ||
|
||
#### Coding Guidelines | ||
|
||
- All source code contributions must strictly adhere to the Holoscan SDK coding style. | ||
|
||
- Make sure that you can contribute your work to open source (no license and/or patent conflict is introduced by your code). You will need to [`sign`](#signing-your-work) your commit. | ||
|
||
- Thanks in advance for your patience as we review your contributions; we do appreciate them! | ||
|
||
#### Pull Requests | ||
Developer workflow for code contributions is as follows: | ||
|
||
1. Developers must first [fork](https://help.github.com/en/articles/fork-a-repo) the [upstream](https://github.com/nvidia-holoscan/holohub) HoloHub repository. | ||
|
||
2. Git clone the forked repository and push changes to the personal fork. | ||
|
||
```bash | ||
git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git HoloHub | ||
# 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. Once the code changes are staged on the fork and ready for review, a [Pull Request](https://help.github.com/en/articles/about-pull-requests) (PR) can be [requested](https://help.github.com/en/articles/creating-a-pull-request) 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. | ||
* While under review, mark your PRs as work-in-progress by prefixing the PR title with [WIP]. | ||
|
||
4. Upon review the PR will be accepted only if it meets the standards for HoloHub. | ||
|
||
#### Signing Your Work | ||
|
||
* 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: | ||
```bash | ||
$ 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. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# HoloHub | ||
|
||
Holohub is a central repository for users and developers of extensions and applications for the Holoscan platform to share reusable components and sample applications. | ||
|
||
# Contributing to HoloHub | ||
|
||
The goal of Holohub is to allow engineering teams to easily contribute and share new functionalities | ||
and demonstration applications. Please review the [CONTRIBUTING.md file](https://github.com/nvidia-holoscan/holohub/blob/main/CONTRIBUTING.md) for more information on how to contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
## Security | ||
|
||
NVIDIA is dedicated to the security and trust of our software products and services, including all source code repositories managed through our organization. | ||
|
||
If you need to report a security issue, please use the appropriate contact points outlined below. **Please do not report security vulnerabilities through GitHub/GitLab.** | ||
|
||
## Reporting Potential Security Vulnerability in an NVIDIA Product | ||
|
||
To report a potential security vulnerability in any NVIDIA product: | ||
- Web: [Security Vulnerability Submission Form](https://www.nvidia.com/object/submit-security-vulnerability.html) | ||
- E-Mail: [email protected] | ||
- We encourage you to use the following PGP key for secure email communication: [NVIDIA public PGP Key for communication](https://www.nvidia.com/en-us/security/pgp-key) | ||
- Please include the following information: | ||
- Product/Driver name and version/branch that contains the vulnerability |