wip readme.md

gistfile1.txt

## Maintainers: components subtree workflow

`packages/components` is maintained with a Git subtree workflow.

### Pull updates from upstream

Before pulling, stop all component/documentation watchers. Watch mode regenerates files such as `packages/components/src/components.d.ts`, which makes the working tree dirty and causes `git subtree pull` to fail.

```bash
# only needed once per clone
git remote add ods-components https://gitlab.apps.ocp-devops-prod.kfw.kfwgruppe.net/kfw/bb-bil/dokumentations-tools/one-bank-design-system/ods-components.git
git subtree add --prefix=packages/components ods-components DEV --squash

# stop watchers first
git restore --source=HEAD --staged --worktree packages/components
git clean -ffdx packages/components
git subtree pull --prefix=packages/components ods-components DEV --squash
```

#### Notes

- `git subtree add`/`git subtree pull` require a clean working tree. If `git status` shows changes, commit, stash, or discard them first.
- If `git subtree add` fails because `packages/components` already exists, remove it and re-add it:

  ```bash
  git rm -r packages/components
  git commit -m "Remove packages/components before subtree re-add"
  git subtree add --prefix=packages/components ods-components DEV --squash
  ```