Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
148 lines (110 loc) · 5.75 KB

CONTRIBUTING.md

File metadata and controls

148 lines (110 loc) · 5.75 KB

PhysicsNeMo Contribution Guide

Introduction

Welcome to Project PhysicsNeMo! We're excited you're here and want to contribute. This documentation is intended for individuals and institutions interested in contributing to PhysicsNeMo. PhysicsNeMo is an open-source project and, as such, its success relies on its community of contributors willing to keep improving it. Your contribution will be a valued addition to the codebase; we simply ask that you read this page and understand our contribution process, whether you are a seasoned open-source contributor or a first-time contributor.

Communicate with Us

We are happy to talk with you about your needs for PhysicsNeMo and your ideas for contributing to the project. One way to do this is to create an issue discussing your thoughts. It might be that a very similar feature is under development or already exists, so an issue is a great starting point. If you are looking for an issue to resolve that will help, refer to the issue section. If you are considering collaborating with the NVIDIA PhysicsNeMo team to enhance PhysicsNeMo, fill out this proposal form and we will get back to you.

Contribute to PhysicsNeMo-CFD

Pull Requests

The developer workflow for code contributions is as follows:

  1. Developers must first fork the upstream PhysicsNeMo-CFD repository.

  2. Clone the forked repository and push changes to the personal fork.

  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.
    • Ensure that you update the CHANGELOG.md to reflect your contributions.
    • Creating a PR kicks off CI and a code review process.
    • At least one PhysicsNeMo engineer will be assigned for the review.

  4. The PR will be accepted and the corresponding issue closed after adequate review and testing have been completed. Note that every PR should correspond to an open issue and should be linked on GitHub.

Licensing Information

All source code files should start with this paragraph:

# SPDX-FileCopyrightText: Copyright (c) 2023 - 2025 NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

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 that contains commits that are not signed off will not be accepted.

  • To sign off on a commit, 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.
  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.

Pre-commit

For PhysicsNeMo development, pre-commit is required. This will not only help developers pass the CI pipeline but also accelerate reviews. Contributions that have not used pre-commit will not be reviewed.

To install pre-commit, follow the steps below inside the PhysicsNeMo repository folder:

pip install pre-commit
pre-commit install

Once the above commands are executed, the pre-commit hooks will be activated and all commits will be checked for appropriate formatting.