docs: instantiate PLC OSS template skeleton and pull sibling files - #5
Merged
Merged
Conversation
Apply the PLC-OSS-Template's own customization steps to the bootstrapped README: - Step 5 (remove meta-instructions section ending at `<!-- REMOVE THE LINE BELOW AND EVERYTHING ABOVE -->`) - Step 2 placeholder substitution: `[Project Title]` -> `DeepStream` - Align LICENSE reference with PLC convention (`LICENSE.md` -> `LICENSE`) Content placeholders inside the project skeleton (`<copy-paste install>`, `<TEAM>`, `<link>`, `<Experimental | Maintained | Stable>`, etc.) and the `GOVERNANCE.md` reference are intentionally left as TODOs - those need real project-specific values, not template substitution. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Committed-By: ankitat's Claude Agent Codex Review: Approved:
…_OF_CONDUCT) The new README references CONTRIBUTING.md, CODE_OF_CONDUCT.md, and LICENSE; none existed in the repo. Pulled all three from the PLC OSS template (github.com/NVIDIA-GitHub-Management/PLC-OSS-Template): - `LICENSE`: Apache 2.0, copied verbatim. - `CONTRIBUTING.md`: `__PROJECT__` -> `DeepStream`, `rapidsai` -> `NVIDIA`. - `CODE_OF_CONDUCT.md`: `__PROJECT__` -> `DeepStream`. Known TODOs left intact (out of scope for the mechanical substitution): - `CONTRIBUTING.md` lines 10, 33-34, 39, 52, 60: six `RAPIDS`-with-capital references and two RAPIDS-specific external URLs (jarmak-nv/rapids- repo-template, docs.rapids.ai/api/cudf) that the literal `rapidsai` substitution didn't catch. - `CONTRIBUTING.md:52` and `:57`: after substitution, links point at `NVIDIA/kb/issues/42` and `orgs/NVIDIA/projects/80` - non-existent targets; need a separate cleanup pass with real DeepStream-team references. - `GOVERNANCE.md`: referenced in README but not present in the PLC template; reference left as a TODO per repo-admin direction. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Committed-By: ankitat's Claude Agent Codex Review: Approved:
…files Per review feedback on PR #5: Removed: - CONTRIBUTING.md (per request - leave dropped from this PR) - skills/ (empty placeholder dir, only contained .gitkeep) - .github/.gitkeep (no longer needed - .github/ now has real content) README.md edits: - Contribution Guidelines section -> "This project is currently not accepting contributions." (drop Start here/CoC/quickstart bullets) - License section: drop `- License: <link>` line, add `- SPDX-License-Identifier: Apache-2.0` Added remaining PLC OSS template files (skipping CLA.md per request), with `__PROJECT__`/`___PROJECT___` -> `DeepStream` and `rapidsai` -> `NVIDIA` substitutions where applicable: - CITATION.md (verbatim - no placeholders) - CHANGELOG.md - print_env.sh (executable) - .github/CODEOWNERS - .github/PULL_REQUEST_TEMPLATE.md - .github/folder_README.md (verbatim) - .github/ISSUE_TEMPLATE/{bug_report,bug_report_form,config, documentation-request,documentation_request_correction, documentation_request_new,feature_request,feature_request_form, submit-question}.{md,yml} - .github/workflow-templates/{add_issue_to_project, add_issue_to_project_raw}.yml Known TODOs left intact (out of scope for mechanical substitution): - .github/CODEOWNERS: `<org>` and `<repo>` placeholders unset - .github/PULL_REQUEST_TEMPLATE.md: links to CONTRIBUTING.md which was removed in this PR - CITATION.md: still contains generic `Project_Name`/`Project_url` example tokens from upstream template - README.md: `<TEAM>`, `<link>`, etc. content placeholders and GOVERNANCE.md reference remain as TODOs Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Committed-By: ankitat's Claude Agent Codex Review: Approved:
Collaborator
Author
|
New commit: What changed:
Local validation:
Known TODOs left intact (out of scope for mechanical substitution; flagged for follow-up):
Current CI state:
Link: #5 |
nvapandya
reviewed
May 15, 2026
nvapandya
left a comment
Collaborator
There was a problem hiding this comment.
[PLC-OSS-Template] clone files looks ok. will need to review further for custom updates for DeepStream
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
2 participants
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
Apply the PLC-OSS-Template's own customization steps to this repo's bootstrapped README, then pull the sibling files the new README references but which weren't present in the repo.
Commits
2d0ee8b—docs(README): instantiate PLC OSS template skeleton<!-- REMOVE THE LINE BELOW AND EVERYTHING ABOVE -->.[Project Title]→DeepStream.LICENSE.md→LICENSE.Net diff on README.md: 86 lines → 70 lines (
-85, +1).Content placeholders inside the project skeleton (
<copy-paste install>,<TEAM>,<link>,<Experimental | Maintained | Stable>, etc.) and theGOVERNANCE.mdreference are intentionally left as TODOs — those need real project-specific values, not template substitution.df32d32—docs: add PLC OSS template sibling files (LICENSE, CONTRIBUTING, CODE_OF_CONDUCT)LICENSECONTRIBUTING.md__PROJECT__→DeepStream,rapidsai→NVIDIACODE_OF_CONDUCT.md__PROJECT__→DeepStreamKnown TODOs left intact
Mechanical substitution scope was limited per the "placeholder substitution only" mode chosen during review. The following follow-ups remain visible in the tree and should be cleaned up in a separate PR:
CONTRIBUTING.mdlines 10, 33–34, 39, 52, 60 — sixRAPIDS-with-capital references and two external RAPIDS-specific URLs (jarmak-nv/rapids-repo-template,docs.rapids.ai/api/cudf) that the lowercaserapidsaisubstitution didn't catch.CONTRIBUTING.md:52and:57— after substitution these becamegithub.laiyagushi.com/NVIDIA/kb/issues/42andgithub.laiyagushi.com/orgs/NVIDIA/projects/80, which don't exist. Need real DeepStream-team-owned labels/board references.README.mdGovernance section referencesGOVERNANCE.md, which is not present in the PLC template. Per repo-admin direction, the reference stays as a TODO rather than a stub file..github/directory currently only contains.gitkeep— PLC template'sCODEOWNERS,PULL_REQUEST_TEMPLATE.md,ISSUE_TEMPLATE/, andworkflow-templates/are not yet imported. Out of scope here.Audit of repo vs PLC template
SECURITY.md(already in repo) — byte-identical to PLC template ✅README.md— was template; now instantiated.LICENSE,CONTRIBUTING.md,CODE_OF_CONDUCT.md— added in this PR.CITATION.md,CHANGELOG.md,CLA.md,print_env.sh,.github/CODEOWNERS,.github/PULL_REQUEST_TEMPLATE.md,.github/ISSUE_TEMPLATE/,.github/workflow-templates/,.github/folder_README.md.