Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (97 loc) · 4.31 KB

CONTRIBUTING.md

File metadata and controls

139 lines (97 loc) · 4.31 KB

Contributing to NV-Redfish

Making Changes

Pull Request Flow

  1. Fork the repository on GitHub

  2. Clone your fork:

    git clone https://github.com/YOUR-USERNAME/nv-redfish.git
cd nv-redfish

  3. Add upstream remote:

    git remote add upstream https://github.com/NVIDIA/nv-redfish.git

  4. Create a feature branch:

    git checkout -b feature/your-feature-name

  5. Make your changes and commit with sign-off:

    git add .
git commit -s -m "Your commit message"

  6. Push to your fork:

    git push origin feature/your-feature-name

  7. Create Pull Request on GitHub:

  8. Once approved, maintainers will merge your PR

Naming conventions in NV-Redfish library

NV-Redfish follows Redfish’s distinction between collections and single resources. When adding new code:

  • Cargo features: use plural kebab-case for collections, and singular kebab-case for singleton services.
  • Rust modules/files: keep names singular (snake_case) and aligned with the corresponding Redfish CSDL entity or complex type.
  • Rust APIs (methods/fields): use plural snake_case for accessors that return collections, and singular snake_case for accessors that return a single resource or service.

In all cases, aim for consistency with the Redfish schema: plural means “many”, singular means “one”, and the same idea should apply to features, modules, and API names.

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.

How to Sign Off

Any contribution which contains commits that are not signed-off will not be accepted.

To sign off on a commit, use the --signoff (or -s) option when committing:

git commit -s -m "Add cool feature"

This will append the following to your commit message:

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

Developer Certificate of Origin (DCO)

By signing off, you certify the following:

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.

Amending Commits

If you forgot to sign off on a commit:

# For the last commit
git commit --amend --signoff

# For multiple commits
git rebase --signoff HEAD~3  # Last 3 commits

Review Process

What to Expect

  1. Automated Checks: CI/CD will run tests, linting, and formatting checks
  2. Code Review: Maintainers will review your code for:
    • Correctness and functionality
    • Code quality and style
    • Test coverage
    • Documentation completeness
  3. Feedback: Address review comments promptly
  4. Approval: At least one maintainer approval required
  5. Merge: Maintainers will merge once approved

License

By contributing to NV-Redfish, you agree that your contributions will be licensed under the same license as the project (see LICENSE file).