mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
7072fa5b37
This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
1.7 KiB
1.7 KiB
Working copies
When you work on Zulip code, there are three working copies of the Zulip git repo that you are generally concerned with:
- local copy: This lives on your laptop or your remove dev instance.
- forked copy: This lives on GitHub, and it's tied to your account.
- official Zulip repo: https://github.com/zulip/zulip
We sometimes call the forked copy the origin remote.
We sometimes call the official repo the upstream remote.
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 repo to your GitHub fork.
- You may fetch commits from the official Zulip repo to your local copy.
- You occasionally may fetch commits from your forked copy.
Sometimes you want to publish commits. Here are 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 master branch.
Names
We call remote working copies of the repository by these short names.
- origin: This is your fork.
- upstream: This is the official Zulip repo.
Relevant git commands
The following commands are useful for moving commits between working copies:
git fetch: This grabs code from another repo to your local copy.git push: This pushes code from your local repo to one of the remotes.git remote: This helps you configure short names for remotes.git pull: Do not use this, please!