Repository navigation
Conversation
Adds the missing must-haves flagged by the GitHub repo-health audit: README: - License section linking to LICENSE (Apache-2.0) - Getting Help section with channels and response expectations - Roadmap section with milestones link (placeholder, pending PM review) - Refreshed Community & Support links (CoC, good-first-issues) CONTRIBUTING: - Code of Conduct callout at the top - Finding a First Issue section with claim process - Fork -> branch -> test -> PR workflow - Pull Request expectations (tests, docs, signing, CI, review etiquette) Roadmap items and response-time targets are explicitly marked as placeholders pending product management review. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
ananthsub
reviewed
Jun 16, 2026
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Contributor
|
@anwithk can you help address these two points
|
| - **[Training Tutorials](https://docs.nvidia.com/nemo/gym/main/training-tutorials)** - Train with NeMo Gym environments | ||
| - **[API Reference](https://docs.nvidia.com/nemo/gym/main/api/reference/api-reference)** - Complete class and function reference | ||
|
|
||
| - **[Roadmap](https://github.com/NVIDIA-NeMo/Gym/issues/1526)** - Plans for the next NeMo Gym release |
Contributor
There was a problem hiding this comment.
@lbliii we have a separate pinned issue for each next release. should we keep updating it in the README (which has a risk of becoming stale) or we could consider linking to the projects which have boards for each release? https://github.com/NVIDIA-NeMo/Gym/projects
|
|
||
| - **[Roadmap](https://github.com/NVIDIA-NeMo/Gym/issues/1526)** - Plans for the next NeMo Gym release | ||
|
|
||
| ## 💬 Getting Help |
Contributor
There was a problem hiding this comment.
do we need separate Getting Help and Community & Support sections? they seem related, can we consolidate?
github-actions
Bot
added
the
sla:review-overdue
This was referenced Sep 8, 2026
svcnvidia-nemo-ci
added
area:docs
This was referenced Oct 22, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses the missing must-haves flagged by the GitHub repo-health dashboard audit (Mar 25, 2026). The audit had README at 5/9 must-haves (Yellow) and CONTRIBUTING at 4/7 must-haves (Yellow).
README — adds the three missing items
LICENSE(Apache-2.0), with a note about per-environment third-party licenses andATTRIBUTIONS.mdgood first issuefilterCONTRIBUTING — adds the four missing items
good first issue/help wantedlinks and a claiming processSome content was synthesized to satisfy the audit's must-haves but has not been confirmed by product management. These are explicitly marked with
[!NOTE]callouts in the rendered docs:These should be replaced with the official targets before the next audit run.
Test plan
https://github.com/NVIDIA-NeMo/Gym/milestonesandhttps://github.com/NVIDIA-NeMo/Gym/discussionsexist or are appropriate to link (enable Discussions if not yet enabled)good first issueandhelp wantedlabels exist on the repo🤖 Generated with Claude Code