64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
2.1 KiB
2.1 KiB
Working copies
When you work on Zulip code, there are three copies of the Zulip Git repository that you are generally concerned with:
- The
upstreamremote. This is the official Zulip repository on GitHub. You probably don't have write access to this repository. - The origin remote: Your personal remote repository on GitHub. You'll use this to share your code and create pull requests.
- local copy: This lives on your laptop or your remote dev instance, and is what you'll use to make changes and create commits.
When you work on Zulip code, you will end up moving code between the various working copies.
Workflows
Sometimes you need to get commits. Here are some scenarios:
- You may fork the official Zulip repository to your GitHub fork.
- You may fetch commits from the official Zulip repository to your local copy.
- You occasionally may fetch commits from your forked copy.
Sometimes you want to publish commits. Here are some scenarios:
- You push code from your local copy to your GitHub fork. (You usually want to put the commit on a feature branch.)
- You submit a PR to the official Zulip repo.
Finally, the Zulip core team will occasionally want your changes!
- The Zulip core team can accept your changes and add them to
the official repo, usually on the
mainbranch.
Relevant Git commands
The following commands are useful for moving commits between working copies:
git fetch: This grabs code from another repository to your local copy. (Defaults to fetching from your default remote,origin).git fetch upstream: This grabs code from the upstream repository to your local copy.git push: This pushes code from your local repository to one of the remotes.git remote: This helps you configure short names for remotes.git pull: This pulls code, but by default creates a merge commit (which you definitely don't want). However, if you've followed our cloning documentation, this will dogit pull --rebaseinstead, which is the only mode you'll want to use when working on Zulip.