|
1 | | -# NemoClaw |
2 | | -Run OpenClaw and other deep agents with security and privacy guarantees |
| 1 | +# __NVIDIA_OSS__ Standard Repo Template |
| 2 | + |
| 3 | +This README file is from the NVIDIA_OSS standard repo template of [PLC-OSS-Template](https://github.com/NVIDIA-GitHub-Management/PLC-OSS-Template?tab=readme-ov-file). It provides a list of files in the PLC-OSS-Template and guidelines on how to use (clone and customize) them. |
| 4 | + |
| 5 | +**Upon completing the customization for the project repo, the repo admin should replace this README template with the project specific README file.** |
| 6 | + |
| 7 | +- Files (org-wide templates in the NVIDIA .github org repo; per-repo overrides allowed) in [PLC-OSS-Template](https://github.com/NVIDIA-GitHub-Management/PLC-OSS-Template?tab=readme-ov-file) |
| 8 | + |
| 9 | + - Root |
| 10 | + - README.md skeleton (CTA + Quickstart + Support/Security/Governance links) |
| 11 | + - LICENSE (Apache 2.0 by default) |
| 12 | + - For other licenses, see the [Confluence page](https://confluence.nvidia.com/pages/viewpage.action?pageId=788418816) for other licenses |
| 13 | + - CLA.md file (delete if not using MIT or BSD licenses) |
| 14 | + - CODE_OF_CONDUCT.md |
| 15 | + - SECURITY.md (vuln reporting path) |
| 16 | + - CONTRIBUTING.md (base; repo can add specifics) |
| 17 | + - SUPPORT.md (Support levels/channels) |
| 18 | + - GOVERNANCE.md (baseline; repo may extend) |
| 19 | + - CITATION.md (for projects that need citation) |
| 20 | + |
| 21 | + - .github/ |
| 22 | + - ISSUE_TEMPLATE/ (<https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository>) |
| 23 | + - bug.yml, feature.yml, task.yml, config.yml |
| 24 | + - PULL_REQUEST_TEMPLATE.md (<https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository>) |
| 25 | + - workflows/ |
| 26 | + - Note: workflow-templates/ for starter workflows should live in the org-level .github repo, not per-repo |
| 27 | + |
| 28 | + - Repo-specific (not org-template, maintained by the team) |
| 29 | + - CODEOWNERS (place at .github/CODEOWNERS or repo root) |
| 30 | + - CHANGELOG.md (or RELEASE.md) |
| 31 | + - ROADMAP.md |
| 32 | + - MAINTAINERS.md |
| 33 | + - NOTICE or THIRD_PARTY_NOTICES / THIRD_PARTY_LICENSES (dependency specific) |
| 34 | + - Build/package files (CMake, pyproject, Dockerfile, etc.) |
| 35 | + |
| 36 | + - Recommended structure and hygiene |
| 37 | + - docs/ |
| 38 | + - examples/ |
| 39 | + - tests/ |
| 40 | + - scripts/ |
| 41 | + - Container/dev env: Dockerfile, docker/, .devcontainer/ (optional) |
| 42 | + - Build/package (language-specific): |
| 43 | + - Python: pyproject.toml, setup.cfg/setup.py, requirements.txt, environment.yml |
| 44 | + - C++: CMakeLists.txt, cmake/, vcpkg.json |
| 45 | + - Repo hygiene: .gitignore, .gitattributes, .editorconfig, .pre-commit-config.yaml, .clang-format |
| 46 | + |
| 47 | + |
| 48 | +## Usage of [PLC-OSS-Template](https://github.com/NVIDIA-GitHub-Management/PLC-OSS-Template?tab=readme-ov-file) for NEW NVIDIA OSS repos |
| 49 | + |
| 50 | +1. Clone the [PLC-OSS-Template](https://github.com/NVIDIA-GitHub-Management/PLC-OSS-Template?tab=readme-ov-file) |
| 51 | +2. Find/replace all in the clone of `___PROJECT___` and `__PROJECT_NAME__` with the name of the specific project. |
| 52 | +3. Inspect all files to make sure all replacements work and update text as needed |
| 53 | + |
| 54 | + |
| 55 | +**What you can reuse immediately** |
| 56 | +- CODE_OF_CONDUCT.md |
| 57 | +- SECURITY.md |
| 58 | +- CONTRIBUTING.md (base) |
| 59 | +- .github/ISSUE_TEMPLATE/.yml (bug/feature/task + config.yml) |
| 60 | +- .github/PULL_REQUEST_TEMPLATE.md |
| 61 | +- Reusable workflows |
| 62 | + |
| 63 | +**What you must customize per repo** |
| 64 | +- README.md: copy the skeleton and fill in product-specific details (Quickstart, Requirements, Usage, Support level, links) |
| 65 | +- LICENSE: check file is correct, update year, consult Confluence for alternatives https://confluence.nvidia.com/pages/viewpage.action?pageId=788418816, add CLA.md only if your license/process requires it |
| 66 | +- CODEOWNERS: replace <TEAM> with your GitHub team handle(s). Place at .github/CODEOWNERS (or repo root) |
| 67 | +- MAINTAINERS.md: list maintainers names/roles, escalation path |
| 68 | +- CHANGELOG.md (or RELEASE.md): track releases/changes |
| 69 | +- SUPPORT.md: Update for your project |
| 70 | +- ROADMAP.md (optional): upcoming milestones |
| 71 | +- NOTICE / THIRD_PARTY_NOTICES (if you ship third‑party content) |
| 72 | +- Build/package files (CMake/pyproject/Dockerfile/etc.), tests/, docs/, examples/, scripts/ as appropriate |
| 73 | +- Workflows: Edit if you need custom behavior |
| 74 | + |
| 75 | + |
| 76 | +4. Change git origin to point to new repo and push |
| 77 | +5. Remove the line break below and everything above it |
| 78 | + |
| 79 | +## Usage for existing NVIDIA OSS repos |
| 80 | + |
| 81 | +1. Follow the steps above, but add the files to your existing repo and merge |
| 82 | + |
| 83 | +<!-- REMOVE THE LINE BELOW AND EVERYTHING ABOVE --> |
| 84 | +----------------------------------------- |
| 85 | +# [Project Title] |
| 86 | +One-sentence value proposition for users. Who is it for, and why it matters. |
| 87 | + |
| 88 | +# Overview |
| 89 | +What the project does? Why the project is useful? |
| 90 | +Provide a brief overview, highlighting key features or problem-solving capabilities. |
| 91 | + |
| 92 | +# Getting Started |
| 93 | +Guide users on how they can get started with the project. This should include basic installation step, quick-start examples |
| 94 | +```bash |
| 95 | +# Option A: Package manager (pip/conda/npm/etc.) |
| 96 | +<copy-paste install> |
| 97 | + |
| 98 | +# Option B: Container |
| 99 | +docker run <image> <args> |
| 100 | + |
| 101 | +# Verify (hello world) |
| 102 | +<one-liner or ~10-line example> |
| 103 | +``` |
| 104 | +# Requirements |
| 105 | +Include a list of pre-requisites. |
| 106 | +- OS/Arch: <summary or link to full matrix> |
| 107 | +- Runtime/Compiler: <versions> |
| 108 | +- GPU/Drivers (if applicable): CUDA <ver>, driver <ver>, etc. |
| 109 | + |
| 110 | +# Usage |
| 111 | +```bash |
| 112 | +# Minimal runnable snippet (≤20 lines) |
| 113 | +<code> |
| 114 | +``` |
| 115 | +- More examples/tutorials: <link> |
| 116 | +- API reference: <link> |
| 117 | + |
| 118 | +# Performance (Optional) |
| 119 | +Summary of benchmarks; link to detailed results and hardware used. |
| 120 | + |
| 121 | +## Releases & Roadmap |
| 122 | +- Releases/Changelog: <link> |
| 123 | +- (Optional) Next milestones or link to `ROADMAP.md`. |
| 124 | + |
| 125 | +# Contribution Guidelines |
| 126 | +- Start here: `CONTRIBUTING.md` |
| 127 | +- Code of Conduct: `CODE_OF_CONDUCT.md` |
| 128 | +- Development quickstart (build/test): |
| 129 | +```bash |
| 130 | +<clone> && <deps> && <build/test> |
| 131 | +``` |
| 132 | +## Governance & Maintainers |
| 133 | +- Governance: `GOVERNANCE.md` |
| 134 | +- Maintainers: <team/handles> |
| 135 | +- Labeling/triage policy: <link> |
| 136 | + |
| 137 | +## Security |
| 138 | +- Vulnerability disclosure: `SECURITY.md` |
| 139 | +- Do not file public issues for security reports. |
| 140 | + |
| 141 | +## Support |
| 142 | +- Level: <Experimental | Maintained | Stable> |
| 143 | +- How to get help: Issues/Discussions/<channel link> |
| 144 | +- Response expectations (if any). |
| 145 | + |
| 146 | +# Community |
| 147 | +Provide the channel for community communications. |
| 148 | + |
| 149 | +# References |
| 150 | +Provide a list of related references |
| 151 | + |
| 152 | +# License |
| 153 | +This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details |
| 154 | +- License: <link> |
0 commit comments