Skip to content

Commit b7864be

Browse files
lhawkman27lhawkinsclaude
authored
Update Claude commands and docs for fork-based workflow (#333)
* chore: update Claude commands for fork-based workflow Update commit-and-push and merge-request commands to use the fork-based contribution workflow. Contributors now push to their fork (origin) and create PRs targeting raft-tech/GeoSet (upstream) using --repo and --head flags. Also documents the workflow in CLAUDE.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: update wiki Contributing section for fork-based workflow Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: simplify fork-based workflow documentation Condense verbose step-by-step fork workflow instructions into concise summaries in CLAUDE.md, wiki/Development-Guide.md, and the merge-request command. Detailed setup steps are standard Git/GitHub practices and don't need to be spelled out in every file. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: lhawkins <lhawkins@teamraft.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b091ffb commit b7864be

4 files changed

Lines changed: 14 additions & 12 deletions

File tree

.claude/commands/commit-and-push.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Stage and commit all changes. Create a meaningful and concise commit message that summarizes the changes.
44

5+
Always push to `origin` (the contributor's fork), never directly to `upstream` (raft-tech/GeoSet).
6+
57
If there is an outstanding merge request associated with the active branch, update the merge request title and description appropriately. Refer to the /merge-request command for further instructions.
68

79
## Documentation Sync (Automatic, Background)

.claude/commands/merge-request.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22

33
Use the gh CLI tool to create a merge request for the current branch. Each merge request should have a concise title and a description of what was changed within the body.
44

5+
This project uses a **fork-based workflow**. PRs are created from the contributor's fork against the upstream repo. When creating or updating PRs:
6+
7+
- Always use `--repo raft-tech/GeoSet` to target the upstream repository.
8+
- Use `--head <fork-owner>:<branch-name>` to specify the source branch from the fork.
9+
510
Additionally, each merge request should be given a score indicating how focused the changes are. The score should range between 1 (unfocused) and 10 (focused). A merge request that changes many different, unrelated parts of the code is a 1. A merge request that focuses on one change is a 10.
611

712
All merge requests should set the target branch to `main`.
813

9-
If a merge request already exists for source branch, update the merge request title and body if necessary.
14+
If a merge request already exists for the source branch, update the merge request title and body if necessary.
1015

1116
## Reviewers
1217

@@ -18,7 +23,7 @@ Always add the following reviewers to every PR using the `--reviewer` flag. **Do
1823

1924
## Structure
2025

21-
Merge requests should comform to the following template.
26+
Merge requests should conform to the following template.
2227

2328
```markdown
2429
## Summary

CLAUDE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Details related to the frontend and plugin development can be found within the `
1616

1717
## Git/GitHub
1818

19-
This is a fork of Apache Superset. When using `gh` CLI commands (PRs, issues, etc.), always target the fork repo explicitly with `--repo raft-tech/GeoSet`.
19+
This is a fork of GeoSet. Contributors use a **fork-based workflow**.
20+
21+
When using `gh` CLI commands (PRs, issues, etc.), always target the upstream repo explicitly with `--repo raft-tech/GeoSet`.
2022

2123
## Versioning
2224

@@ -30,4 +32,4 @@ Wiki pages live in `wiki/` and are synced to the GitHub Wiki on merge to main vi
3032

3133
- Always use context7 when I need code generation, setup or configuration steps, or
3234
library/API documentation. This means you should automatically use the Context7 MCP
33-
tools to resolve library id and get library docs without me having to explicitly ask.
35+
tools to resolve library id and get library docs without me having to explicitly ask.

wiki/Development-Guide.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,7 @@ The GeoSet map plugin is a Superset chart plugin built on [deck.gl](https://deck
112112

113113
## Contributing
114114

115-
1. Create a feature branch from `main`:
116-
117-
```bash
118-
git checkout -b your-feature-name main
119-
```
120-
121-
2. Make your changes and test locally
122-
3. Submit a PR against `main` on [raft-tech/GeoSet](https://github.com/raft-tech/GeoSet)
115+
This project uses a **fork-based workflow**. Fork the repo, create a feature branch from `main`, and open a PR against `main` on [raft-tech/GeoSet](https://github.com/raft-tech/GeoSet).
123116

124117
### PR Guidelines
125118

0 commit comments

Comments
 (0)