NVIDIA-NeMo / NVIDIA-NeMo/DataDesigner

Add README to plans/ folder

Open Beginner friendly
#753 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.2k
Forks
211
Avg merge
2d 6h
Merged PRs (30d)
40

Description

Context

The repository has a top-level plans/ directory with development planning artifacts organized by issue or initiative, for example plans/343/..., plans/645/..., and named workstream folders. There is not currently a top-level plans/README.md explaining what these files are or how humans and coding agents should use them.

Without that context, the folder can be mistaken for product documentation, architecture source of truth, or scratch space, and agents may add or update plans inconsistently.

Proposal

Add plans/README.md that explains:

  • what the planning docs are and how they relate to GitHub issues, PRs, and implementation work
  • the expected folder naming conventions, such as plans/<issue-number>/... for issue-backed work and named workstream folders when appropriate
  • what belongs in plans/ versus product docs, architecture/, or temporary scratch notes
  • guidance for agents: keep plans factual, link relevant issues and PRs, update stale plans when work changes, and avoid treating plans as user-facing documentation
  • how to include supporting assets such as diagrams or images when a plan needs them

Acceptance criteria

  • A top-level plans/README.md exists.
  • The README gives concise context for both human contributors and coding agents.
  • It documents the current observed structure of the plans/ directory.
  • It clarifies that these are development planning artifacts, not product documentation.
  • It includes enough guidance that future plans can be added consistently.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the existing plans/ directory, including plans/343/ and plans/645/ and named workstream folders, to document its current structure accurately. Create plans/README.md covering the proposal and acceptance criteria, then verify that it distinguishes planning artifacts from product documentation, architecture/, and scratch notes and gives consistent guidance for humans and coding agents.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.