|
1 |
| -# CNC Tutorials: Git/Github |
| 1 | +# Forking Workflow |
2 | 2 |
|
3 | 3 | ## Intro
|
4 |
| -Welcome to the Git/Github tutorial repository! We will use this repo to demonstrate a workflow that allows for collaborative development of a shared code repository. It has the features: |
| 4 | +Welcome to the Forking Workflow tutorial! Here we will demonstrate a workflow that allows for collaborative development of a shared code repository. It has the features: |
5 | 5 | - individual developers "fork" some shared repository
|
6 | 6 | - development occurs on individual, forked remote/local repositories
|
7 | 7 | - individual development gets integrated into shared repository through Pull Requests (PRs)
|
8 | 8 | 
|
9 | 9 |
|
10 |
| -**Honorable mention**: There is a separate workflow that you may encounter which uses branches within the same repository wit |
| 10 | +**Honorable mention**: There is a separate workflow that you may encounter which uses branches within the same repository to achieve similar affects. There is a tutorial for that as well: https://github.com/pqz317/cnc_github_tutorial/blob/main/feature_branch_workflow.md |
11 | 11 |
|
12 | 12 | The steps through this demo are:
|
13 |
| -1. Forking a repo |
14 |
| -2. Creating a new branch |
15 |
| -3. Pushing the branch, |
16 |
| -4. Creating a pull request |
17 |
| -5. Dealing with merge conflicts |
| 13 | +1. Fork this repo on Github |
| 14 | +2. Clone this forked repo to a local repo |
| 15 | +3. Make local changes |
| 16 | +4. Push your changes to your forked repo on Github |
| 17 | +5. Creating a Pull Request to integrate your changes into the "parent" repo |
| 18 | +6. Fetching changes from the parent repo to your local repo |
| 19 | +7. (Potentially) resolving |
| 20 | + |
| 21 | +## 1. Forking a Repo |
| 22 | +If there is an existing remote repository you'd like to start development on, usually the first thing to do would be to create a "fork" of this repository for yourself. This provides you with a repository on Github that is a clone of its "parent", where you can do any type of development and testing on without affecting the parent. |
| 23 | +Fork this repo with |
18 | 24 |
|
19 |
| -## 1. Cloning a repo |
20 |
| -If there is an existing remote repository you'd like to start development on, usually the first thing to do would be to clone that repository to your local machine. |
21 |
| -To obtain a local copy of any repo, go to a directory you'd like to place the repo in, and run: |
22 |
| -``` |
23 |
| -git clone <REPOSITORY_URL> |
24 |
| -``` |
25 | 25 | For this repo, the command to run locally will be:
|
26 | 26 | ```
|
27 | 27 | git clone https://github.com/pqz317/cnc_github_tutorial.git
|
|
0 commit comments