Skip to content

Commit 992dbab

Browse files
docs(readme): declare fork status and document upstream sync workflow
GitHub does not allow retro-converting an existing repo into a fork (fork relationship is only established via the Fork button at creation time), so the relationship to upstream pondpilot/flowscope is recorded explicitly in the README instead: - Top-of-file Note: states this is a personal fork of pondpilot/flowscope with customizations (Trellis AI workflow, audit review page, derived-subquery JOIN fix, Cursor IDE platform support). - New "Syncing with upstream" section: documents the git remote layout (origin = personal fork, upstream = pondpilot/flowscope with push intentionally disabled), the standard fetch/merge/push flow, and the one-shot `git sync-upstream` alias. Repo metadata on GitHub also updated via gh repo edit: - Topics: fork, sql-lineage, trellis, rust, wasm, cursor-ide - Homepage: points to https://github.com/pondpilot/flowscope Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 621f76c commit 992dbab

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FlowScope
22

3+
> **Note**: This is a personal fork of [`pondpilot/flowscope`](https://github.com/pondpilot/flowscope) maintained by [@cooker-code](https://github.com/cooker-code) with additional customizations (Trellis AI workflow integration, audit review page, derived-subquery JOIN fix, Cursor IDE platform support). Upstream is tracked via the `upstream` git remote and synced periodically; see [Syncing with upstream](#syncing-with-upstream) below.
4+
35
[![CI](https://github.com/pondpilot/flowscope/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/pondpilot/flowscope/actions/workflows/ci.yml)
46
[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](docs/README.md)
57
[![codecov](https://codecov.io/gh/pondpilot/flowscope/graph/badge.svg)](https://codecov.io/gh/pondpilot/flowscope)
@@ -206,6 +208,30 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, testing expectations, and cont
206208

207209
The core engine and packages are released under Apache-2.0. See [LICENSE](LICENSE) for details. The `app/` directory uses the O'Saasy License; see [app/LICENSE](app/LICENSE).
208210

211+
## Syncing with upstream
212+
213+
This fork tracks `pondpilot/flowscope` via the `upstream` git remote. To pull in upstream changes:
214+
215+
```bash
216+
git fetch upstream
217+
git log --oneline master..upstream/master # preview what's new
218+
git merge upstream/master # or: git rebase upstream/master
219+
git push origin master
220+
```
221+
222+
If you set up a one-shot alias:
223+
224+
```bash
225+
git config alias.sync-upstream '!git fetch upstream && git merge upstream/master && git push origin master'
226+
git sync-upstream
227+
```
228+
229+
The `upstream` remote has its push URL intentionally disabled to prevent accidental pushes to `pondpilot/flowscope`. Restore it explicitly if you ever need to open a PR:
230+
231+
```bash
232+
git remote set-url --push upstream https://github.com/pondpilot/flowscope.git
233+
```
234+
209235
---
210236

211237
Part of the [PondPilot](https://github.com/pondpilot/pondpilot) project.

0 commit comments

Comments
 (0)