tssc-hpcg/CONTRIBUTING.md

NVIDIA HPCG Contribution Rules

Issue Tracking

• All enhancement, bugfix, or change requests must begin with the creation of a NVIDIA HPCG Issue Request.
• The issue request must be reviewed by NVIDIA HPCG engineers and approved prior to code review.

Coding Guidelines

• Please follow the existing conventions in the relevant file, submodule, module, and project when you add new code or when you extend/fix existing functionality.

• To maintain consistency in code formatting and style, you should also run clang-format on the modified sources with the provided configuration file. This applies NVIDIA HPCG code formatting rules to:

  • class, function/method, and variable/field naming
  • comment style
  • indentation
  • line length

• Format git changes:

  # Commit ID is optional - if unspecified, run format on staged changes.
  git-clang-format --style file [commit ID/reference]
  

• Format individual source files:

  # -style=file : Obtain the formatting rules from .clang-format
  # -i : In-place modification of the processed file
  clang-format -style=file -i -fallback-style=none <file(s) to process>
  

• Format entire codebase (for project maintainers only):

  find samples plugin -iname *.h -o -iname *.c -o -iname *.cpp -o -iname *.hpp \
  | xargs clang-format -style=file -i -fallback-style=none
  

• Try to keep pull requests (PRs) as concise as possible:

  • Avoid committing commented-out code.
  • Wherever possible, each PR should address a single concern. If there are several otherwise-unrelated things that should be fixed to reach a desired endpoint, our recommendation is to open several PRs and indicate the dependencies in the description. The more complex the changes are in a single PR, the more time it will take to review those changes.

• Write commit titles using imperative mood and these rules, and reference the Issue number corresponding to the PR. Following is the recommended format for commit texts:

#<Issue Number> - <Commit Title>

<Commit Body>

• Ensure that the build log is clean, meaning no warnings or errors should be present.

• All OSS components must contain accompanying documentation (READMEs) describing the functionality, dependencies, and known issues.

• 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 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 the upstream NVIDIA-HPCG repository.

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

git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git NVIDIA-HPCG
# 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 (PR) can be requested 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.
• At least one NVIDIA-HPCG engineer will be assigned for the review.
• While under review, mark your PRs as work-in-progress by prefixing the PR title with [WIP].

4. Since there is no CI/CD process in place yet, the PR will be accepted and the corresponding issue closed only after adequate testing has been completed, manually, by the developer and/or NVIDIA-HPCG engineer reviewing the code.

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:

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

  This will append the following to your commit message:

  Signed-off-by: Your Name <your@email.com>
  

• Full text of the DCO:

    Developer Certificate of Origin
    Version 1.1
  
    Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
  
    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.