Skip to content

Latest commit

 

History

History
174 lines (133 loc) · 8.6 KB

CONTRIBUTING.md

File metadata and controls

174 lines (133 loc) · 8.6 KB
Raw

Introduction

Welcome to NVIDIA FLARE! We're excited you're here and want to contribute. This documentation is intended for individuals and institutions interested in contributing to NVIDIA FLARE. NVIDIA FLARE 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 code base; we simply ask that you read this page and understand our contribution process, whether you are a seasoned open-source contributor or whether you are a first-time contributor.

Communicate with us

We are happy to talk with you about your needs for NVIDIA FLARE 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.

The contribution process

Pull request early

We encourage you to create pull requests early. It helps us track the contributions under development, whether they are ready to be merged or not. Change your pull request's title, to begin with [WIP] and/or create a draft pull request until it is ready for formal review.

Preparing pull requests

To ensure the code quality, NVIDIA FLARE relies on several linting tools: (flake8 and its plugins, black and isort)

This section highlights all the necessary preparation steps required before sending a pull request. To collaborate efficiently, please read through this section and follow them.

Checking the coding style

We check code style using flake8 and isort. A bash script (runtest.sh) is provided to run all tests locally.

License information: all source code files should start with this paragraph:

# Copyright (c) 2021-2022, NVIDIA CORPORATION.  All rights reserved.
#
# 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.

Unit testing

NVIDIA FLARE tests are located under test/. The unit test file names follow the [module_name]_test.py pattern.

The bash script runtest.sh will run unit tests also.

Building the documentation

To build the docs, first make sure you have all requirements

python3 -m pip install -U pip
python3 -m pip install nvflare[dev]

To build the docs, please run.

./build_docs.sh --html

Once built, you can view the docs in docs/_build folder. To clean the docs, please run

./build_docs.sh --clean

Signing your work

NVIDIA FLARE enforces the Developer Certificate of Origin (DCO) on all pull requests.

For a detailed guide on signing commits, please see Signing commits from GitHub.

Commit signature verification

NVIDIA FLARE enforces commit signature verification, a security feature provided by GitHub. Developers are required to setup GPG keys as described in Commit Signature Verification.

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.

Submitting pull requests

All code changes to the main branch must be done via pull requests.

  1. Create a new ticket or take a known ticket from the issue list.
  2. Check if there's already a branch dedicated to the task.
  3. If the task has not been taken, create a new branch in your fork of the codebase. Ideally, the new branch should be based on the latest main branch.
  4. Make changes to the branch (use detailed commit messages if possible).
  5. Make sure that new tests cover the changes and the changed codebase passes all tests locally.
  6. Create a new pull request from the task branch to the main branch, with detailed descriptions of the purpose of this pull request.
  7. Check the CI/CD status of the pull request, make sure all CI/CD tests passed.
  8. Assign 2 reviewers. One of the reviewers must be a code owner for this section of code.
  9. Wait for reviews; if there are reviews, make point-to-point responses, make further code changes if needed.
  10. If there are conflicts between the pull request branch and the main branch, pull the changes from the main and resolve the conflicts locally.
  11. Reviewer and contributor may have discussions back and forth until all comments addressed. All conversations must be resolved for PR to pass.
  12. Wait for the pull request to be merged.

The code reviewing process

Reviewing pull requests

All code review comments should be specific, constructive, and actionable.

  1. Check the CI/CD status of the pull request, make sure all CI/CD tests passed before reviewing (contact the branch owner if needed).
  2. Read carefully the descriptions of the pull request and the files changed, write comments if needed.
  3. Make in-line comments to specific code segments, request for changes if needed.
  4. Review any further code changes until all comments addressed by the contributors.
  5. Merge the pull request to the main branch.
  6. Close the corresponding task ticket on the issue list.