Skip to content

docs(WIP_tools): add repoCmdFiles README and structure#7

Merged
neiljthomson merged 1 commit into
mainfrom
add-WIP-tools
Nov 6, 2025
Merged

docs(WIP_tools): add repoCmdFiles README and structure#7
neiljthomson merged 1 commit into
mainfrom
add-WIP-tools

Conversation

@neiljthomson

Copy link
Copy Markdown
Collaborator

Best Practice for "Work In Progress" WIP is to create a separate image of the repo folder structure which is not directly involved with committing changes to the repo. The idea is work on files the WIP folder space until ready for merge/commit/push, then copy/paste to the matching folder/file in the repo (non-WIP) folders and then do a commit.

To support this a number of command (.bat) files are included to manage the WIP -> repo file transfer and a facility to make snapshots of the repo folder structure which can be for various reasons, including when needing to revert to a previous version of a file

Summary

Adds WIP_tools directory and README documenting the repoCmdFiles workflow (run in WIP, versioned in repo).

Changes

  • WIP_tools/README.md
  • Initial folder structure under WIP_tools/

Verification

  1. README renders correctly on GitHub.
  2. (Optional) Run the robocopy commands to deploy to:
    C:\Users\nthomson\Projects\RepoName-WIP\repoCmdFiles\

Summary

Motivation

Changes

Breaking changes

  • None
  • If any, describe migration notes.

Documentation

  • Updated docs in /docs
  • Updated PUML diagrams in /model/puml
  • Added/updated examples

Validation

  • Schemas validate (if applicable)
  • Diagrams render (if applicable)
  • Tests pass (if applicable)

IPR / Sign-off

  • I have the right to submit this contribution under the project license(s).
  • (If WG requires DCO) My commits are Signed-off-by.

Best Practice for "Work In Progress" WIP is to create a separate image of the repo folder structure which is not directly involved with committing changes to the repo. The idea is work on files the WIP folder space until ready for merge/commit/push, then copy/paste to the matching folder/file in the repo (non-WIP) folders and then do a commit.

To support this a number of command (.bat) files are included to manage the WIP -> repo file transfer and a facility to make snapshots of the repo folder structure which can be for various reasons, including when needing to revert to a previous version of a file

### Summary
Adds WIP_tools directory and README documenting the repoCmdFiles workflow (run in WIP, versioned in repo).

### Changes
- WIP_tools/README.md
- Initial folder structure under WIP_tools/

### Verification
1) README renders correctly on GitHub.
2) (Optional) Run the robocopy commands to deploy to:
   C:\Users\nthomson\Projects\RepoName-WIP\repoCmdFiles\
@neiljthomson neiljthomson merged commit 925a4cf into main Nov 6, 2025
1 check passed
@neiljthomson neiljthomson deleted the add-WIP-tools branch November 6, 2025 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant