Skip to content

docs: add fork sync and measured PR workflow #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brawlaphant wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add fork sync and measured PR workflow #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,30 @@ This repository is part of a larger ecosystem transformation. Contributors—whe
6. Merge after approval
```

### Fork Sync & Measured PR Workflow

Use this when contributing from a fork to keep `main` clean and PRs easy to review.

```
1. Add upstream once:
git remote add upstream https://github.com/regen-network/agentic-tokenomics.git
2. Sync local main:
git checkout main
git fetch upstream origin
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The command git fetch upstream origin fetches from both the upstream and origin remotes. For clarity and consistency with step 5 (which uses git fetch upstream), it's better to fetch only from upstream. The subsequent command git reset --hard upstream/main only requires changes from the upstream remote, making the fetch from origin unnecessary for this step.

Suggested change
git fetch upstream origin
git fetch upstream

git reset --hard upstream/main
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The git reset --hard command is destructive as it discards any local commits on the main branch. It would be helpful to add a comment to explicitly warn contributors about this, reinforcing the idea that development work should be done on separate feature branches, not on main.

Suggested change
git reset --hard upstream/main
# WARNING: This command discards any local changes and commits on your main branch.
git reset --hard upstream/main

git push --force-with-lease origin main
3. Create a scoped branch from main:
git checkout -b codex/<short-topic>
4. Keep PR scope small:
one concern per PR, minimal file touch, tests included
5. Rebase before opening/updating PR:
git fetch upstream
git rebase upstream/main
git push --force-with-lease origin codex/<short-topic>
```

Recommended PR size: ~100-300 LOC and one clearly stated outcome.

### Style Guide

- Use clear, accessible language (see the [Living Language Tone skill](https://github.com/regen-network/regen-ai-core), available to core contributors)
Expand Down