forked from asmeurer/git-workflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit f6e304e
Showing
2 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Git workflow | ||
|
||
This document describes the git workflow that should be used when contributing | ||
to open source projects. It assumes a very basic understanding of git | ||
(commits, branches, etc.) using the command line. | ||
|
||
**Note: This workflow is designed for open source (i.e., public) | ||
repositories. The workflow for private repositories may be slightly different, | ||
in particular, the repository's team may prefer for you to not fork the repo | ||
but rather push branches to it directly (although note that GitHub does allow | ||
you to fork private repositories that you have push access to and keeps the | ||
fork private).** | ||
|
||
For this document, we will suppose that you want to contribute a patch to | ||
[conda/conda](https://github.com/conda/conda). | ||
|
||
## Cloning and forking the repository | ||
|
||
**Note: The steps in this section only need to be performed once per | ||
repository (i.e., if you contribute a second change to conda/conda, you would | ||
not need to repeat them, but if you contribute to | ||
[conda/conda-build](https://github.com/conda/conda-build) you will need to | ||
repeat them for that repository.** | ||
|
||
1. Clone the repository. Copy the url ① and type, in this case | ||
|
||
``` | ||
git clone [email protected]:conda/conda-build.git | ||
``` | ||
|
||
at the terminal. If you have not set up your ssh keys with GitHub, use the | ||
https url ②. | ||
|
||
![clone.png](clone.png) |