Skip to content

contributing guide updates - #881

Merged
sephmard merged 23 commits into
mainfrom
llane/contributing-udpates
Aug 11, 2026
Merged

sephmard merged 23 commits into
mainfrom
llane/contributing-udpates

Conversation

@vadam5

@vadam5 vadam5 commented Mar 11, 2026

Copy link
Copy Markdown
Contributor

Replacement PR for: #662
Contributors: @lbliii

first pass at guidelines for AI-enabled contributions. Open to all ideas/suggestions.

Comment thread docs/contribute/development-setup.md Resolved

@jmabry jmabry left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Documentation appears in triplicate. Possible to reference a single-source of truth so that is more DRY in any secondary docs?

@cmunley1

Copy link
Copy Markdown
Contributor

can we update the DCO fix instructions regarding force push too?

Comment thread docs/contribute/development-setup.md Resolved
lbliii and others added 2 commits June 16, 2026 13:16
…pates

Signed-off-by: Lawrence Lane <llane@nvidia.com>
- Single-source the 'Use of AI and LLM Tools' section in the Fern
  development-setup page; CONTRIBUTING.md and the contribute index now
  carry the guiding principle plus a link instead of duplicating it (DRY).
- Recommend tracking worthwhile drive-by changes as their own issue.
- Add a PR template with an AI-assistance disclosure section and point
  attribution guidance at it (commit trailer kept as an alternative).
- Reframe 'What We Will Close' as 'When We Request Changes' (close only
  if unaddressed).
- Document force-push (--force-with-lease) when fixing DCO sign-off on an
  already-pushed branch.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
@lbliii
lbliii requested a review from a team as a code owner June 16, 2026 17:23
@copy-pr-bot

copy-pr-bot Bot commented Jun 16, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@lbliii

lbliii commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Thanks for the reviews β€” addressed all the feedback in ddd270a9 (the branch is now merged up to main).

Note on scope: this branch predated the Fern docs migration, so it was editing the old docs/contribute/*.md tree (since deleted on main, which is why it showed conflicts). I merged main in and the content now lives in the Fern pages under fern/versions/latest/pages/contribute/.

Changes:

  • DRY / triplicate (@jmabry): the full "Use of AI and LLM Tools" section now lives in one place β€” the Fern development-setup page. CONTRIBUTING.md and the contribute index keep just the guiding principle and link to it.
  • Drive-by edits as an issue (@jmabry): noted in the "Keep PRs focused" bullet.
  • PR template (@jmabry): added .github/PULL_REQUEST_TEMPLATE.md with an AI-assistance disclosure section; attribution guidance points there first.
  • Request changes vs close (@cmunley1): section is now "When We Request Changes"; close only if feedback is unaddressed.
  • DCO fix + force push (@cmunley1): the DCO-fix troubleshooting now documents git push --force-with-lease after an amend/rebase rewrites already-pushed history.

fern check passes (0 errors).

@github-actions

Copy link
Copy Markdown
Contributor

@lbliii
lbliii requested review from cmunley1, jmabry and lbliii June 16, 2026 17:25
jmabry
jmabry previously approved these changes Jun 26, 2026
@sephmard sephmard added the documentation Improvements to documentation label Jun 29, 2026
@github-actions github-actions Bot added the sla:review-overdue Review response is over the one-business-day SLA label Jul 17, 2026
jmabry
jmabry previously approved these changes Aug 11, 2026

@jmabry jmabry left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LG%C

sephmard and others added 2 commits August 11, 2026 13:34
Co-authored-by: JOSHUA MABRY <mabryjn@gmail.com>
Signed-off-by: Seph Mard <seph.mard@gmail.com>
sephmard and others added 3 commits August 11, 2026 13:38
Remove PR-template AI disclosure and the attribution section, point agents
at AGENTS.md, clarify main.yml nav edits, and separate NVIDIA Slack from
external Fern org access requests.

Signed-off-by: Seph Mard <smard@nvidia.com>
Signed-off-by: Seph Mard <smard@nvidia.com>
@sephmard
sephmard disabled auto-merge August 11, 2026 17:39
Make DCO -s required and cryptographic signing optional, point the
quality bar at AGENTS.md, clarify Fern org access requests and Makefile
login for externals, and allow N/A on the PR tests checklist.

Signed-off-by: Seph Mard <smard@nvidia.com>
@sephmard

Copy link
Copy Markdown
Contributor

/claude review

@claude

claude Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

SHIP β€” LGTM, no reliability concerns.

Docs/metadata-only change (7 files: PR template, AGENTS.md, CONTRIBUTING.md, Makefile echo text, fern/README.md, two MDX pages). No code, verifier, async, config, or public-API surface touched β€” nothing that can corrupt scores or hang a run.

The substantive change is a policy shift: cryptographic commit signing (-S) moves from required to optional, with DCO sign-off (-s) remaining the enforced bar. That's applied consistently across CONTRIBUTING.md, contribute/index.mdx, and development-setup.mdx, and the workflow example is updated to drop -S. Internally consistent and correct.

Note (author's call, non-blocking): this relaxes an existing convention β€” CLAUDE.md still states "All commits require DCO sign-off (-s) and cryptographic signature (-S)." Worth aligning CLAUDE.md in a follow-up so the repo has one source of truth.

@jmabry jmabry left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

AGENTS.md and Claude.md will be out of sync now. Need something akin to

my-ai-library/
β”œβ”€β”€ AGENTS.md                  # Unified root instructions (Codex, Claude, Copilot)
β”œβ”€β”€ CLAUDE.md                  # Claude-specific rules or symlink to AGENTS.md
...

Merge former CLAUDE.md content into AGENTS.md (DCO -s only; -S optional)
and turn CLAUDE.md into a symlink so Claude Code and other tools stay in sync.

Signed-off-by: Seph Mard <smard@nvidia.com>
@sephmard

Copy link
Copy Markdown
Contributor

@jmabry Addressed the AGENTS.md / CLAUDE.md sync concern:

  • AGENTS.md is now the unified root instructions (quality bar + former CLAUDE.md architecture/patterns)
  • CLAUDE.md is a symlink to AGENTS.md
  • Dropped the stale β€œ-S required” line so it matches DCO-only CI (-S optional)

sephmard

This comment was marked as spam.

@sephmard
sephmard requested review from cmunley1 and jmabry August 11, 2026 18:17

@jmabry jmabry left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Comment thread AGENTS.md

1. **Dataset** β€” JSONL with one task per row. NeMo Gym uses the OpenAI Responses API as its native format because it natively represents multi-turn, tool-calling agentic trajectories without custom serialization. Each row has `responses_create_params.input` (the input messages in Responses API format) and `verifier_metadata` (task-specific data passed to the verifier)
2. **Resources Server** β€” implements verification logic, environment-specific tools, and per-task state isolation
3. **Agent Harness** β€” reuse a built-in agent harness (e.g. OpenHands) or bring your own

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

feels we should mention multi agent somewhere - eg user simulation etc - but fine for another time

Comment thread AGENTS.md
pre-commit install

# Run servers
gym env start \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

should prob include rollouts, and setting env.yaml

@sephmard
sephmard removed the request for review from lbliii August 11, 2026 18:52
@sephmard
sephmard merged commit ab2d9c4 into main Aug 11, 2026
17 checks passed
@sephmard
sephmard deleted the llane/contributing-udpates branch August 11, 2026 18:56
@github-project-automation github-project-automation Bot moved this from Dev Todo to Done in NeMo Gym 0.6.0 - Sept 2 Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to documentation sla:review-overdue Review response is over the one-business-day SLA

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

clarify Fern setup instructions for external contributors

6 participants