mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-22 08:38:13 +02:00
feat: add devcontainer based setup docs
This commit is contained in:
parent
1eb6c534d8
commit
c4df866bcf
10 changed files with 311 additions and 125 deletions
41
docs/contribution/fork-workflow.mdx
Normal file
41
docs/contribution/fork-workflow.mdx
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: Fork Workflow
|
||||
description: Keep your Dograh fork connected to upstream.
|
||||
---
|
||||
|
||||
The contributor bootstrap script configures two remotes:
|
||||
|
||||
- `origin`: your fork, where you push
|
||||
- `upstream`: `dograh-hq/dograh`, where new commits land
|
||||
|
||||
If you cloned `dograh-hq/dograh` directly instead of your fork, run this once inside the devcontainer after it boots:
|
||||
|
||||
```bash
|
||||
bash scripts/setup_fork.sh
|
||||
```
|
||||
|
||||
To pull in upstream changes:
|
||||
|
||||
```bash
|
||||
git fetch upstream
|
||||
git checkout main
|
||||
git merge upstream/main
|
||||
git push origin main
|
||||
```
|
||||
|
||||
Check your remotes any time with:
|
||||
|
||||
```bash
|
||||
git remote -v
|
||||
```
|
||||
|
||||
You should see:
|
||||
|
||||
```bash
|
||||
origin https://github.com/<YOUR_HANDLE>/dograh.git (fetch/push)
|
||||
upstream https://github.com/dograh-hq/dograh.git (fetch/push)
|
||||
```
|
||||
|
||||
<Note>
|
||||
Always push feature branches to **`origin`** (your fork), then open a pull request against `dograh-hq/dograh:main`. Never push directly to `upstream`.
|
||||
</Note>
|
||||
Loading…
Add table
Add a link
Reference in a new issue