diff --git a/README.md b/README.md index aea30079..9411ce3a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Please leave this repository open in a browser tab so that you can follow along ## Next -Next we will walk through the process of creating a Fork repository and setting up a local clone. +Next we will walk through the process of creating a GitHub Fork and local clone of this repository. [Go](/walkthrough/1-setup.md) diff --git a/app/index.md b/app/index.md index 60586822..30d8201d 100644 --- a/app/index.md +++ b/app/index.md @@ -8,16 +8,16 @@ Welcome to _Flavor_, the only place on the planet where your taste buds won't be ### [Cuba Pudding Jr.](writer/cuba-pudding-jr.md) | cubapud@flavor.magazine -[Grilled Peach Salad](recipe/jan/grilled-peach-salad.md) +[Grilled Peach Salad](recipe/feb/oatmeal-pancakes.md) ### [Eggs Benny](writer/eggs-benny.md) | englishmuffin@flavor.magazine -[Vanilla Panna Cotta](recipe/jan/vanilla-panna-cotta.md) +[Egg Benny](recipe/feb/egg-benny.md) ### [John Lemon](writer/john-lemon.md) | zestmaster@flavor.magazine -[Homemade Sausages](recipe/jan/homemade-sausages.md) +[John Lemon](recipe/feb/john-lemon.md) ### [Madame Croque](writer/madame-croque.md) | mmecroque@flavor.magazine -[Chocolate Soup](recipe/jan/chocolate-soup.md) +[Roast Pork and Pickled Cucumber Sandwich](../recipe/feb/madame-croque-feb.md) diff --git a/app/recipe/feb/egg-benny.md b/app/recipe/feb/egg-benny.md new file mode 100644 index 00000000..ef7f25bd --- /dev/null +++ b/app/recipe/feb/egg-benny.md @@ -0,0 +1,19 @@ +#Egg Benny + +A short recipe description. + +Source: https://example.com/link/to/original/recipe/ + +## Ingredients + +- Egg +- Pine nuts +- dried cranberries +- Salt + + +# Instructions + +1. Break off or trim the woody ends from the asparagus and discard. Set the spears aside. +2. Heat the olive oil in a skillet over medium heat. Stir in the pine nuts, cranberries, and salt. Cook and stir until the pine nuts start to look translucent, 5 to 6 minutes. Add the asparagus spears and cook, adding a little more olive oil if needed, until stalks are bright green and tender, about 5 to 8 minutes. Serve on a platter with the cranberries and nuts spooned over the top of the asparagus. + diff --git a/app/recipe/feb/john-lemon.md b/app/recipe/feb/john-lemon.md new file mode 100644 index 00000000..dee6c938 --- /dev/null +++ b/app/recipe/feb/john-lemon.md @@ -0,0 +1,20 @@ +# Candied Carrots + +My family's favorite vegetable. They are great for the holidays, too! + +Source: https://www.allrecipes.com/recipe/18241/candied-carrots/ + +## Ingredients + +- 1 pound carrots, cut into 2 inch pieces +- 2 tablespoons butter, diced +- ¼ cup packed brown sugar +- 1 pinch salt +- 1 pinch ground black pepper + + +## Instructions + +1. Place carrots in a pot of salted water. Bring water to a boil, reduce heat to a high simmer and cook about 20 to 30 minutes. Do not cook the carrots to a mushy stage! +2. Drain the carrots, reduce the heat to its lowest possible setting and return the carrots to the pan. Stir in butter, brown sugar, salt and pepper. Cook for about 3 to 5 minutes, until sugar is bubbly. Serve hot! + diff --git a/app/recipe/feb/madame-croque-feb.md b/app/recipe/feb/madame-croque-feb.md new file mode 100644 index 00000000..808b47c4 --- /dev/null +++ b/app/recipe/feb/madame-croque-feb.md @@ -0,0 +1,34 @@ +# Roast Pork and Pickled Cucumber Sandwich + +The best roast pork you'll ever eat! + +Source: https://www.realsimple.com/food-recipes/browse-all-recipes/roast-pork-sandwich + +## Ingredients + +- IngredientsIngredient Checklist + +- 1 pound boneless pork loin + +- ½ teaspoon cayenne pepper + +kosher salt and black pepper + +- 1 cucumber, thinly sliced + +- 3 tablespoons cider vinegar + +- 2 tablespoons olive oil + +- 2 teaspoons brown sugar + +- ⅓ cup mayonnaise + +- 4 Portuguese rolls, split + +# Instructions + +1. Heat oven to 450° F. Season the pork with the cayenne and ¼ teaspoon salt. Roast on a rimmed baking sheet until an instant-read thermometer inserted in the center reaches 145° F, 20 to 25 minutes; thinly slice. +2. Meanwhile, combine the cucumber, vinegar, oil, brown sugar, and ¼ teaspoon each salt and black pepper in a medium bowl. +3. Divide the mayonnaise, pork, and cucumber among the rolls. + diff --git a/app/recipe/feb/oatmeal-pancakes.md b/app/recipe/feb/oatmeal-pancakes.md new file mode 100644 index 00000000..1b348370 --- /dev/null +++ b/app/recipe/feb/oatmeal-pancakes.md @@ -0,0 +1,43 @@ +# Recipe Title + +A short recipe description. + +Source: https://www.allrecipes.com/recipe/228654/quick-oatmeal-pancakes/ + +## Ingredients + +- 1 cup milk + +- ⅔ cup quick-cooking oats + +- ⅔ cup all-purpose flour + +- 2 tablespoons brown sugar + +- 1 ½ teaspoons baking powder + +- ½ teaspoon salt + +- ¼ teaspoon ground cinnamon + +- 2 eggs + +- 2 teaspoons butter, melted + +- ½ teaspoon vanilla extract + +- ¼ cup milk, or more as needed + +- 2 teaspoons butter, or as needed + + +# Instructions + +Step 1 +Place 1 cup milk in a microwave-safe bowl; heat in microwave until bubbling, about 2 minutes. Stir in the oats. + +Step 2 +Mix flour, brown sugar, baking powder, salt, and cinnamon together in a bowl. Whisk eggs, 2 teaspoons melted butter, and vanilla extract together in a separate bowl; add 1/4 cup milk. Mix oat mixture and egg mixture with flour mixture; stir to combine. + +Step 3 +Heat 2 teaspoons butter on a griddle or skillet over medium heat; pour about 1/3 cup batter into the hot butter. Cook pancakes until bubbles appear on top layer, about 5 minutes. Flip and cook other side until evenly browned, about 5 more minutes. diff --git a/app/writer/cuba-pudding-jr.md b/app/writer/cuba-pudding-jr.md index dc2bfe39..d25bc6d3 100644 --- a/app/writer/cuba-pudding-jr.md +++ b/app/writer/cuba-pudding-jr.md @@ -5,3 +5,5 @@ Recipe Picks: - January: [Grilled Peach Salad](../recipe/jan/grilled-peach-salad.md) +- February: [Oatmeal Pancakes](../recipe/feb/oatmeal-pancakes.md) + diff --git a/app/writer/eggs-benny.md b/app/writer/eggs-benny.md index 18d7bb16..c25d4ebb 100644 --- a/app/writer/eggs-benny.md +++ b/app/writer/eggs-benny.md @@ -5,3 +5,5 @@ Recipe Picks: - January: [Vanilla Panna Cotta](../recipe/jan/vanilla-panna-cotta.md) +- Febuary: [Egg Benny](../recipe/feb/egg-benny.md) + diff --git a/app/writer/john-lemon.md b/app/writer/john-lemon.md index 97b2ce12..5a49a15c 100644 --- a/app/writer/john-lemon.md +++ b/app/writer/john-lemon.md @@ -5,3 +5,4 @@ Recipe Picks: - January: [Homemade Sausages](../recipe/jan/homemade-sausages.md) +- Febuary: [John Lemon](../recipe/feb/john-lemon.md) \ No newline at end of file diff --git a/app/writer/madame-croque.md b/app/writer/madame-croque.md index 68c5fbe8..9bcfd8ac 100644 --- a/app/writer/madame-croque.md +++ b/app/writer/madame-croque.md @@ -5,3 +5,5 @@ Recipe Picks: - January: [Chocolate Soup](../recipe/jan/chocolate-soup.md) +- February: [Roast Pork and Pickled Cucumber Sandwich](../recipe/feb/madame-croque-feb.md) + diff --git a/walkthrough/1-setup.md b/walkthrough/1-setup.md index 8affd780..94fab5b1 100644 --- a/walkthrough/1-setup.md +++ b/walkthrough/1-setup.md @@ -1,6 +1,6 @@ # 1. Setup -In order to contribute to a GitHub project, you will need two things: a Fork of the project and a local clone of your Fork. +In order to contribute to a GitHub project, you will need two things: a GitHub Fork and a local clone of this project. ## :running: Activities @@ -15,19 +15,22 @@ Fork the source repository: 1. Visit https://github.com/source-username/repository-name. 2. Click the "fork" button, and choose your personal GitHub account if prompted. +--- + +:cop: :raised_hand: - Please wait until everyone has caught up. + +:construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: :construction: + +--- ### 2 - Clone your Fork __All Team Members__ -Fork the source repository: - 1. Visit https://github.com/source-username/repository-name. - 2. Click the "fork" button, and choose your personal GitHub account if prompted. - -Clone your fork to your local machine: +Clone this project to your local machine: ```sh $ cd ~/my/parent/directory -$ git clone https://github.com/username/repository-name.git +$ git clone https://github.com/source-username/repository-name.git # clone the fork repository from GitHub $ cd repository-name @@ -40,16 +43,16 @@ $ git remote origin $ git remote -v -origin https://github.com/username/repository-name.git (fetch) -origin https://github.com/username/repository-name.git (push) +origin https://github.com/source-username/repository-name.git (fetch) +origin https://github.com/source-username/repository-name.git (push) ``` -You should see an `origin` remote that points to your GitHub fork: +You should see an `origin` remote that points to the source GitHub project: ```sh $ git remote show origin * remote origin - Fetch URL: https://github.com/username/repository-name.git - Push URL: https://github.com/username/repository-name.git + Fetch URL: https://github.com/source-username/repository-name.git + Push URL: https://github.com/source-username/repository-name.git HEAD branch: master Remote branches: develop tracked @@ -88,66 +91,54 @@ $ git branch -a --- -### 3 - Add Remote for Source Repository +### 3 - Add Remote for your GitHub Fork __All Team Members__ -Add a `source` remote: +Add a `me` remote: ```sh -$ git remote add source https://github.com/source-username/repository-name.git -# add the source remote +$ git remote add me https://github.com/your-username/repository-name.git +# add the me remote $ git remote -v -origin https://github.com/username/repository-name.git (fetch) -origin https://github.com/username/repository-name.git (push) -source https://github.com/source-username/repository-name.git (fetch) -source https://github.com/source-username/repository-name.git (push) +origin https://github.com/source-username/repository-name.git (fetch) +origin https://github.com/source-username/repository-name.git (push) +me https://github.com/your-username/repository-name.git (fetch) +me https://github.com/your-username/repository-name.git (push) ``` -You should see a `source` remote that points to the upstream GitHub source repository: +You should see a `me` remote that points to your GitHub Fork repository: ```sh -$ git remote show source -* remote origin - Fetch URL: https://github.com/source-username/repository-name.git - Push URL: https://github.com/source-username/repository-name.git +$ git remote show me +* remote me + Fetch URL: https://github.com/your-username/repository-name.git + Push URL: https://github.com/your-username/repository-name.git HEAD branch: master Remote branches: - develop new (next fetch will store in remotes/source) - master new (next fetch will store in remotes/source) + develop new (next fetch will store in remotes/me) + master new (next fetch will store in remotes/me) Local ref configured for 'git push': master pushes to master (up to date) ``` Maintainers will need to create branches and push directly to the source repository. -All team members will need to pull changes from the source repository and merge them into -their own branches. +All team members will need to pull changes from the source repository in order to branch from for feature branches. -Fetch branch data from the `source` remote: +Fetch branch data from the `origin` remote: ```sh -$ git fetch source +$ git fetch origin From https://github.com/source-username/repository-name -* [new branch] develop -> source/develop -* [new branch] master -> source/master +* [new branch] develop -> origin/develop +* [new branch] master -> origin/master $ git branch -a * master remotes/origin/HEAD -> origin/master remotes/origin/develop remotes/origin/master - remotes/source/develop - remotes/source/master - -$ git remote show source -* remote source - Fetch URL: https://github.com/source-username/repository-name.git - Push URL: https://github.com/source-username/repository-name.git - HEAD branch: master - Remote branches: - develop tracked - master tracked - Local ref configured for 'git push': - master pushes to master (up to date) + remotes/me/develop + remotes/me/master ``` --- @@ -164,19 +155,19 @@ __All Team Members__ By now you should have noticed that you do not have a local `develop` branch ```sh -git branch +$ git branch * master ``` -Create a `develop` branch that tracks from your GitHub fork's `develop` branch: +Create a `develop` branch that tracks from `origin`'s `develop` branch: ```sh -git branch develop origin/develop +$ git checkout -b develop --track origin/develop Branch develop set up to track remote branch develop from origin ``` -Notice that viewing the details for the `origin` remote indicates that the local `develop` and `master` branches are configured to push to and pull from your GitHub fork's branches: +Notice that viewing the details for the `origin` remote indicates that the local `develop` and `master` branches are configured to push to and pull from the source GitHub repository's branches: ```sh -git remote show origin +$ git remote show origin ... Local branches configured for 'git pull': develop merges with remote develop @@ -188,11 +179,13 @@ git remote show origin :bulb: The `-vv` flag for the `git branch` command will also show the remote branches that are tracked by your local branches (in brackets): ```sh -git branch --vv - develop 3e03a92 [origin/develop] Create example app -* master 3e03a92 [origin/master] Create example app +$ git branch -vv +* develop 3e03a92 [origin/develop] Create example app + master 3e03a92 [origin/master] Create example app ``` +You should now be ready to move on to the rest of the walkthrough. If you'd like to see the repository you've created on your local machine in GitHub desktop, you can add a repository by choosing a local path. + --- :cop: :raised_hand: - Please wait until everyone has caught up. @@ -201,8 +194,6 @@ git branch --vv --- -You should now be ready to move on to the rest of the walkthrough. If you'd like to see the repository you've created on your local machine in GitHub desktop, you can add a repository by choosing a local path. - ## Next Next we will walk through the process of creating feature branches, publishing changes to GitHub, and making a request to merge changes into the source repository using a Pull Request. diff --git a/walkthrough/2-feature-branches.md b/walkthrough/2-feature-branches.md index 04989099..16f54546 100644 --- a/walkthrough/2-feature-branches.md +++ b/walkthrough/2-feature-branches.md @@ -27,18 +27,7 @@ Create a feature branch off of the `develop` branch that contains the writer's n ```sh $ git checkout develop -$ git branch cuba-pudding-jr-feb - -$ git branch - cuba-pudding-jr-feb - develop -* master -``` - -Next, switch to the newly created feature branch: -```sh -$ git checkout cuba-pudding-jr-feb -Switched to branch 'cuba-pudding-jr-feb' +$ git checkout -b cuba-pudding-jr-feb $ git branch * cuba-pudding-jr-feb @@ -46,10 +35,11 @@ $ git branch master ``` -:bulb: You can simplify the last two steps to create and switch to a branch with a single command: +:bulb: Feature branches will be named such that someone else can look at what branches are in progress and get a rough idea of what work is being done on each branch. + +:bulb: You can create a branch without immediately checking out the branch via the `git branch` command: ```sh -$ git checkout -b cuba-pudding-jr-feb -Switched to a new branch 'cuba-pudding-jr-feb' +$ git branch cuba-pudding-jr-feb ``` --- @@ -62,11 +52,12 @@ Switched to a new branch 'cuba-pudding-jr-feb' ### 2 - Make Changes to the Project -__All Team Members___ +__All Team Members__ In your text editor, make the following changes: + 1. Add the new recipe under the [`/app/recipe/feb/`](/app/recipe/feb/) directory. -2. Update the writer's page in the [`/app/writer/`](/app/writer/) direcotry. +2. Update the writer's page in the [`/app/writer/`](/app/writer/) directory. 3. Update the main mage [`/app/index.md`](/app/index.md). Since other people are going to be making changes at the same time, be careful not to make changes to lines of code that are not relevant to your change. @@ -79,9 +70,9 @@ Since other people are going to be making changes at the same time, be careful n --- -### 3 - Diff Changes +### 3 - Review Changes -__All Team Members___ +__All Team Members__ If you view the current git status, you will see 2 files with unstaged changes and a new folder that has not been tracked by git: ```sh @@ -114,7 +105,7 @@ index ac3abad..9777cd5 100644 ### [Cuba Pudding Jr.](writer/cuba-pudding-jr.md) | cubapud@flavor.magazine -[Grilled Peach Salad](recipe/jan/grilled-peach-salad.md) -+[Quick Oatmeal Pancakes]( recipe/feb/quick-oatmeal-pancakes.md) ++[Quick Oatmeal Pancakes](recipe/feb/quick-oatmeal-pancakes.md) ### [Eggs Benny](writer/eggs-benny.md) | englishmuffin@flavor.magazine @@ -147,9 +138,8 @@ If you see that you have changes to unexpected lines, please correct them at thi Stage all of the changes that you've made thus far: ```sh -$ git add -A -# Careful, -A stages changes to all tracked files, untracks files that have been -# removed, and tracks files that have been added. +$ git add app/* +# Careful, using a wildcard adds any file that has changed that matches the pattern. $ git status On branch cuba-pudding-jr-feb @@ -182,10 +172,13 @@ $ git commit -m "Adding Cuba Pudding Jr.'s Feb Recipe" Now that your changes have been committed, let's get them published to your Fork on GitHub: ```sh -$ git push origin cuba-pudding-jr-feb +$ git push -u me HEAD ``` -:bulb: Make sure you type the correct branch name. +:bulb: Specifying the HEAD reference instructs git to push to the same branch as the HEAD of your local project, which is currently your feature branch. + +:bulb: The `-u` flag instructs git to link your local branch with the remote's branch so that future push & pull commands do not require you +to specify where you would like to push or pull code from. Navigate to your Fork on Github, you should now see your new branch in the interface. diff --git a/walkthrough/3-code-review.md b/walkthrough/3-code-review.md index 56b713a0..999f724a 100644 --- a/walkthrough/3-code-review.md +++ b/walkthrough/3-code-review.md @@ -17,6 +17,7 @@ __All Team Members__ Navigate to the source repository on GitHub, click the "Pull Requests" tab, and click on the Pull Request opened by the team member sitting to your right. Review the following things: + 1. Verify that the user is requesting to merge their feature branch into the `develop` branch. 2. Check to see if there is any important information on the Conversation tab. 3. Check the Commits tab to get a high-level view of the individual changes that were made. @@ -42,14 +43,14 @@ If you are curious to run someone else's code locally, you will need to set up a Create a remote pointing to the person to your right's Fork: ```sh -$ git remote add teammate https://github.com/teammmate-username/repository-name.git +$ git remote add teammate https://github.com/teammate-username/repository-name.git # add the teammate remote $ git remote -v -origin https://github.com/username/repository-name.git (fetch) -origin https://github.com/username/repository-name.git (push) -source https://github.com/source-username/repository-name.git (fetch) -source https://github.com/source-username/repository-name.git (push) +me https://github.com/your-username/repository-name.git (fetch) +me https://github.com/your-username/repository-name.git (push) +origin https://github.com/source-username/repository-name.git (fetch) +origin https://github.com/source-username/repository-name.git (push) teammate https://github.com/teammate-username/repository-name.git (fetch) teammate https://github.com/teammate-username/repository-name.git (push) ``` @@ -68,13 +69,31 @@ $ git branch -r --list teammate/* Checkout a tracking branch: ```sh -$ git checkout -b teammate-feature-branch teammate/eggs-benny-feb +$ git checkout eggs-benny-feb Branch teammate-feature-branch set up to track remote branch eggs-benny-feb from teammate. Switched to a new branch 'teammate-feature-branch' ``` +:bulb: As long as only one of your remotes has a branch called eggs-benny-feb, it knows to create a local tracking branch. + +:bulb: If you do not wish to create a tracking branch, you can check out the branch in read-only mode by fully-specifying the branch instead (e.g., `teammate/eggs-benny-feb`) + Now you've switched the code in your directory to a branch containing all of the changes committed to your teammate's branch. If you have your project open in sublime or another text editor you will notice that the source files contain your teammate's changes. +If you run the `git log` command you can see a log of the latest commits made to the current branch: +```sh +$ git log +commit 6b7a7c2bc46753d0d394758b8fd04bcd3b4cf896 +Author: My Teammate +Date: Mon Feb 8 12:58:20 2016 -0500 + + Adding Eggs Benny February Recipe + +... +``` + +:bulb: Press enter to scroll through lines & Ctrl+C to exit the log. + Once you are done, you can delete this branch: ```sh $ git checkout develop diff --git a/walkthrough/4-fetching-latest.md b/walkthrough/4-fetching-latest.md index ad0133f3..2607ea7b 100644 --- a/walkthrough/4-fetching-latest.md +++ b/walkthrough/4-fetching-latest.md @@ -8,31 +8,17 @@ Now that mods have been merged into the development branch, it is prudent to get ## :running: Activities -Follow along with the activities below to walk through the process of fetching the latest commits to the `source/develop` branch, merging them into your local `develop` branch, and publishing them back out to your GitHub fork. +Follow along with the activities below to walk through the process of pulling the latest commits to the `origin/develop` branch into your local tracking branch. -### 1 - Fetch Latest from Source +### 1 - Pull Latest from `develop` __All Team Members__ -Fetch the latest commits from the source repository: -```sh -$ git fetch source -``` - -Merge the new commits contained in the `source/develop` branch into your `develop` branch: +Pull the latest commits to the `develop` branch from the source repository: ```sh $ git checkout develop -# switch to develop branch -$ git merge source/develop -# merge commits from source/develop into your current branch (develop) -``` - -Your local `develop` branch is now up to date with the source `develop` branch. - -Now, publish your develop branch out to your GitHub fork: -```sh -$ git push origin develop +$ git pull ``` ## Next diff --git a/walkthrough/5-hotfix.md b/walkthrough/5-hotfix.md index 333e5100..88182081 100644 --- a/walkthrough/5-hotfix.md +++ b/walkthrough/5-hotfix.md @@ -51,14 +51,12 @@ $ git commit -m "Bump version to 1.0.1" __Maintainers__ -Choose a maintainer to publish the hotfix branch. This maintainer should push the branch to source: +Choose a maintainer to publish the hotfix branch. This maintainer should push the branch to origin: ```sh -$ git push source hotfix-1.0.1 +$ git push -u origin HEAD ``` -At this time create a pull request to merge the hotfix branch into `master`, but do not yet merge. - --- :cop: :raised_hand: - Please wait until everyone has caught up. @@ -71,15 +69,15 @@ At this time create a pull request to merge the hotfix branch into `master`, but __Developers__ -Fetch the latest from source and create a local tracking branch for the hotfix: +Fetch the latest from origin and create a local tracking branch for the hotfix: ```sh -$ git fetch source -# fetch latest from source +$ git fetch origin +# fetch latest from origin $ git checkout hotfix-1.0.1 # checkout the hotfix branch -Branch hotfix-1.0.1 set up to track remote branch hotfix-1.0.1 from source. +Branch hotfix-1.0.1 set up to track remote branch hotfix-1.0.1 from origin. Switched to a new branch 'hotfix-1.0.1' ``` @@ -114,7 +112,7 @@ Choose a developer to publish the fixup branch and create a Pull Request against Publish the branch: ```sh -$ git push origin remove-emails +$ git push -u me HEAD ``` Navigate to your GitHub fork and open the pull request, making sure to request to merge changes into the `hotfix-1.0.1` branch. @@ -157,16 +155,17 @@ $ git pull Merge hotfix into develop, creating a new merge commit (via `--no-ff`): ```sh $ git checkout develop -# switch to develop -$ git merge hotfix-1.0.1 --no-ff -m "Merging 1.0.1" +$ git pull + +$ git merge --no-ff hotfix-1.0.1 ``` :bulb: Always make sure that `develop` is up to date before merging. There may be some merge conflicts that will need to be addressed at this point. -Choose a maintainer to push the the commit up to the source repository: +Push the commit up to the origin repository: ```sh -$ git push source develop +$ git push ``` ## Next diff --git a/walkthrough/6-release-branch.md b/walkthrough/6-release-branch.md index 73412da4..e5d2ea90 100644 --- a/walkthrough/6-release-branch.md +++ b/walkthrough/6-release-branch.md @@ -14,11 +14,9 @@ __Maintainers__ Bring your local develop branch up to date with the source repository: ```sh -$ git fetch source - $ git checkout develop -$ git merge source/develop +$ git pull ``` Create a new branch off of `develop` named `release-1.1`: @@ -46,17 +44,9 @@ __Maintainers__ Choose a maintainer to publish the release branch to the source repository: ```sh -$ git push source release-1.1 +$ git push -u origin HEAD ``` -### 3 - Open Pull Request - -__Maintainers__ - -Choose a maintainer to open a pull request to merge the release branch into the `master` branch. __Do not merge the pull request at this time__. - -This pull request is a good place to document all of the changes that comprise the release, perform a final review of the code that will be pushed, and comment on any issues related to the release. - ## Next Next we will walk through the process of fixing bugs in the release branch. diff --git a/walkthrough/7-release-bugs.md b/walkthrough/7-release-bugs.md index 984fe91a..a45813ab 100644 --- a/walkthrough/7-release-bugs.md +++ b/walkthrough/7-release-bugs.md @@ -14,15 +14,15 @@ Follow along with the activities below to walk through the process of fixing iss __Developers__ -Fetch the latest from source and create a local tracking branch for the release: +Fetch the latest from origin and create a local tracking branch for the release: ```sh -$ git fetch source -# fetch latest from source +$ git fetch origin +# fetch latest from origin $ git checkout release-1.1 # checkout the release branch -Branch hotfix-1.1 set up to track remote branch release-1.1 from source. +Branch hotfix-1.1 set up to track remote branch release-1.1 from origin. Switched to a new branch 'hotfix-1.0.1' ``` @@ -56,7 +56,7 @@ __Developers__ The two developers from the last step should now publish their feature branches to GitHub and open up Pull Requests against the `release-1.1` branch in the source repository: ```sh -$ git push origin FEATURE-BRANCH-NAME +$ git push -u me HEAD ``` --- diff --git a/walkthrough/8-completed-release.md b/walkthrough/8-completed-release.md index 4cf12f55..3868d58d 100644 --- a/walkthrough/8-completed-release.md +++ b/walkthrough/8-completed-release.md @@ -12,7 +12,21 @@ It is the last day of the month and no more requests have come in from the, time __Maintainers__ -Choose a maintainer to accept & merge the request to merge `release-1.1` into `master`. +Choose a maintainer to merge `release-1.1` into `master`. + +```sh +$ git checkout release-1.1 + +$ git pull + +$ git checkout master + +$ git pull + +$ git merge --no-ff release-1.1 + +$ git push +``` --- @@ -29,20 +43,12 @@ __Maintainers__ Next we will work to get changes made to the release merged back down into `develop`, so switch to the release branch and pull down all the latest changes: ```sh $ git checkout release-1.1 -# switch to release branch - -$ git pull -# pull latest changes -``` - -:bulb: Running git pull on a tracking branch will automatically fetch and merge changes. -Merge the release into develop, creating a new merge commit (via `--no-ff`): -```sh $ git checkout develop -# switch to develop -$ git merge release-1.1 --no-ff -m "Merging 1.1" +$ git merge --no-ff release-1.1 + +$ git push ``` :bulb: Always make sure that `develop` is up to date before merging. There may be some merge conflicts that will need to be addressed at this point.