Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > Guides > Chef Cookbooks Developer Guide > Developer > Source Control Management Systems > GitHub > Clone vs. Fork > Fork a Cookbook Repository

Fork a Cookbook Repository

Objective

To fork an existing cookbook repository on GitHub.  

Table of Contents

Prerequisites

  • GitHub account. See Create a free GitHub acount.
  • Access to the cookbook repository that you want to fork. You can fork any public repository, but if you want to fork a private repository, you must contact the repository owner to request access.

Note: In order to submit code submissions, you must complete a RightScale Contributors Agreement found here.

Overview

If you want to contribute code enhancements to an existing repository, you should create a new repository by creating a fork of the original. For example, if you want to contribute minor bug fixes, enhancements, or new features to another git project, the easiest way for those changes to be merged into the original repository is with a Pull Request from a forked repository. See Make a Pull Request on GitHub.

Note: When you fork a repository, all metadata associated with the repository such as commit messages, branches, tags, etc. are copied over to the new repository so that it's an exhaustive duplicate of the repository and all of its contents.

Steps

The easiest way to fork a cookbook repository from GitHub's web interface or use the command line utility, Knife, on your Chef development machine.

Fork a Repository on GitHub

  1. Go to the Chef repository that you would like to fork. (e.g. https://github.com/username/repository_name)
     
  2. Click the Fork button in the top right corner.
    screen-ForkRepo-v1.png
     
  3. You now have an editable version of the original repository in your GitHub account that you can modify for your own purposes. Forked repositories are denoted as such under the repository name. 
    screen-ForkedRepo-v1.png
     
  4. Now that you forked the cookbook repository, you can edit the cookbooks in your own editable copy and eventually contribute back to the original project at a later time by making a Pull Request.
     
  5. In order to use the cookbooks in your fork of the original repository, you must Add a Repository to your RightScale account and Import Cookbooks from a Repository
You must to post a comment.
Last modified
14:06, 26 Sep 2013

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.