Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
136 lines (100 loc) · 5.2 KB

CONTRIBUTING.md

File metadata and controls

136 lines (100 loc) · 5.2 KB
Raw

Contributing

We welcome external contributions to NeMo-Speech.cpp.

AI usage

You may use AI tools as assistants for code, but the contribution must be yours. Pull request descriptions, issues and review replies must be written by you.

  • Disclose it. If AI was used, mention in the pull request in what capacity it was used.
  • Write it yourself. Issues, pull request descriptions and review replies must be your own words, not AI output.
  • Review it. Review every line of code before submitting. You should understand and be able to explain the design and any line of code when a reviewer asks.
  • Verify it. Build and run the relevant tests and benchmarks yourself, and report the commands and results you actually ran.
  • Keep it focused. Don't include unrelated refactors, reformatting or speculative changes that a tool added along the way.

Pull requests that don't follow these guidelines may be closed without review.

Automated review

The project uses AI tools too: CodeRabbit and Greptile review every pull request, configured in .coderabbit.yaml and greptile.json. Their comments are suggestions; a maintainer decides what must change before merging. Fix the findings that are valid, and reply briefly to the ones that are not so reviewers can see why. The rules above apply to those replies as well.

Development checks

Follow the source-build guide for prerequisites and submodules. For a model-independent CPU ASR test build:

git submodule update --init llama.cpp
scripts/configure.sh cpu-asr -DNEMO_SPEECH_BUILD_TESTS=ON
cmake --build --preset cpu-asr
ctest --test-dir build/cpu-asr --output-on-failure

Install pre-commit and run the same formatting, license-header, and static file checks used by CI:

pre-commit run --all-files

Use the closest matching CUDA, Metal, Vulkan, server, or component preset when the change affects code outside the CPU ASR path. Include the commands and results relevant to the change in the pull request.

Changing llama.cpp or ggml

The llama.cpp submodule stays at its pinned upstream commit. Changes to it, including ggml, live as patches in patches/, which explains the patch format and the scripts/llama-patches.sh workflow.

Contribution license and provenance

Unless a file states otherwise, contributions are submitted under the Apache License 2.0. Preserve all existing copyright, license, and attribution notices.

If a contribution contains or is derived from third-party code, data, generated content, or model artifacts, identify its source, revision, copyright holder, and license in the pull request. Preserve its original notices and update THIRD_PARTY_NOTICES.md when applicable. Do not submit material under terms that are incompatible with this project. Contributions may be held for provenance and license review before acceptance.

Signing off your work

Every commit must be signed off. By adding a Signed-off-by line to a commit, you agree to the Developer Certificate of Origin (DCO) 1.1 reproduced below: you certify that you wrote the contribution or otherwise have the right to submit it under the project's open source license, and you acknowledge that the contribution and your sign-off are public and kept permanently. Commits without a Signed-off-by line will not be accepted.

Use Git's --signoff (or -s) option:

git commit --signoff -m "Add a feature"

This appends:

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

Developer Certificate of Origin

Signing off certifies that at least one of (a), (b), or (c) below applies to your contribution, and that you agree to (d). The full, unmodified Developer Certificate of Origin 1.1 follows:

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.