Skip to content

Conversation

@chtruong814
Copy link
Collaborator

What does this PR do ?

Update CONTRIBUTING.md

@nithinraok requested we update the Contributing guide.

  • Realistically, I don't think developers currently can just run pytest and run the entire test suite successfully. I updated the guide to indicate that it is best to run the unit test suite based on what changed and reference the L0_Unit_Test scripts for specific env vars needed.
  • Clarified how to trigger the Github CI with labels
  • Clarified that the style command should also be selectively ran against certain files changed. Currently, not all files have styles fixed
  • Updated the reviewers that should be tagged, assuming the repo is Speech focused. Need to double check those names. If non-Speech changes are made for now, I think the Nvidia NeMo developers know who to appropriate tag.

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
CONTRIBUTING.md Outdated
1. For changes to NeMo's ASR collection: @titu1994, @redoctopus, @jbalam-nv, or @okuchaiev
1. For changes to NeMo's NLP collection: @MaximumEntropy, @ericharper, @ekmb, @yzhang123, @VahidooX, @vladgets, or @okuchaiev
1. For changes to NeMo's TTS collection: @blisc, or @okuchaiev
Tag @nithinraok or @blisc initially for a review.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nithinraok who should be tagged here assuming the repo is just Speech?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is good enough. May be we can be specific, something like:

Please tag @nithinraok for NeMo core and ASR related works, @blisc for TTS related.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated. Please take another look.

Co-authored-by: oliver könig <okoenig@nvidia.com>
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
@nithinraok
Copy link
Member

currently all issues are getting assigned to Oleksii by default. Can we also update them.

@chtruong814
Copy link
Collaborator Author

@nithinraok I created an issue to test if it was tagging someone by default, and it didn't seem to happen? Do you know of recent cases?
#15270

Signed-off-by: Charlie Truong <chtruong@nvidia.com>
nithinraok
nithinraok previously approved these changes Jan 8, 2026
Copy link
Member

@nithinraok nithinraok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nithinraok
Copy link
Member

@nithinraok I created an issue to test if it was tagging someone by default, and it didn't seem to happen? Do you know of recent cases? #15270

Thanks @chtruong814. We should be good then.

ko3n1g
ko3n1g previously approved these changes Jan 8, 2026
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
@chtruong814 chtruong814 dismissed stale reviews from ko3n1g and nithinraok via 7ec4290 January 8, 2026 16:40
@github-actions github-actions bot added the CI label Jan 8, 2026
@chtruong814 chtruong814 merged commit 55ef515 into main Jan 9, 2026
50 of 74 checks passed
@chtruong814 chtruong814 deleted the chtruong/update-contributing branch January 9, 2026 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants