-
Notifications
You must be signed in to change notification settings - Fork 2
[task] Clarify current scaffold status in README #3
Copy link
Copy link
Closed as not planned
Labels
area: docsProject documentation and contributor guidance.Project documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.A scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.A student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.Documentation-only changes or issues.
Milestone
Metadata
Metadata
Assignees
Labels
area: docsProject documentation and contributor guidance.Project documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.A scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.A student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.Documentation-only changes or issues.
Area
Docs
Goal
Make the README honest about the current state of the project: Nexgit is an early scaffold, not a working GitHub/repo manager yet.
Why this matters
New contributors should not be asked to document screenshots or working examples that do not exist. The README should help students understand what is real today, what is placeholder behavior, and where the first useful product work starts.
Relevant files
README.mddocs/product/README.mddocs/product/foundation/vision.mdapps/cli/src/main.rsapps/cli/src/tui/ui.rsapps/desktop/src/renderer/src/App.tsxDepends on
None. This can be claimed immediately.
Current behavior
The project has setup docs, product direction, a Rust CLI/TUI scaffold, and an Electron desktop scaffold.
The project does not yet have a real working repo manager experience. Repo status is still placeholder behavior until the core repo-status issues land.
Target behavior
README includes a short
Current statusor similar section that says plainly:v0.1.0 - Contributor MVPmilestone to find real implementation work.Out of scope
Definition of done
Verification
pnpm format:prettier:checkContributor notes
This is a good first issue because it is a small docs task with a clear boundary. The main job is honesty and clarity, not marketing.