docs/v2-3/contributing-code.html

<!DOCTYPE html>
<head>
    <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<meta name="description" content="   Contributing to Singularity                                                 Contribute to the codeTo contribute to the development of Singularity, you must:  Own the code and/or have the right to contribute it  Be able to submit software under the 3 clause BSD (or equivalent) license (while other licenses are allowed to be submitted by the license, acceptance of any contribution is up to the project lead)  Read, understand and agree to the license  Have a GitHub account (this just makes it easier on me)We use the traditional Github Flow to develop. This means that you fork the repo and checkout a branch to make changes, you submit a pull request (PR) to the development branch with your changes, and the development branch gets merged with master for official releases. We also have an official CONTRIBUTING document, which also includes a code of conduct.Step 1. Fork the repoTo contribute to the web based documentation, you should obtain a GitHub account and fork the Singularity repository. Once forked, you will want to clone the fork of the repo to your computer. Let’s say my Github username is vsoch, and I am using ssh:git clone git@github.com:vsoch/singularity.gitcd singularity/Step 2. Set up your configThe github config file, located at .git/config, is the best way to keep track of many different forks of a repository. I usually open it up right after cloning my fork to add the repository that I forked as a remote, so I can easily get updated from it. Let’s say my .git/config first looks like this, after I clone my own branch:      [core]              repositoryformatversion = 0              filemode = true              bare = false              logallrefupdates = true      [remote "origin"]              url = git@github.com:vsoch/singularity              fetch = +refs/heads/*:refs/remotes/origin/*      [branch "master"]              remote = origin              merge = refs/heads/masterI would want to add the upstream repository, which is where I forked from.      [core]              repositoryformatversion = 0              filemode = true              bare = false              logallrefupdates = true      [remote "origin"]              url = git@github.com:vsoch/singularity              fetch = +refs/heads/*:refs/remotes/origin/*      [remote "upstream"]              url = https://github.com/singularityware/singularity              fetch = +refs/heads/*:refs/remotes/origin/*      [branch "master"]              remote = origin              merge = refs/heads/masterI can also add some of my colleagues, if I want to pull from their branches:      [core]              repositoryformatversion = 0              filemode = true              bare = false              logallrefupdates = true      [remote "origin"]              url = git@github.com:vsoch/singularity              fetch = +refs/heads/*:refs/remotes/origin/*      [remote "upstream"]              url = https://github.com/singularityware/singularity              fetch = +refs/heads/*:refs/remotes/origin/*      [remote "greg"]              url = https://github.com/gmkurtzer/singularity              fetch = +refs/heads/*:refs/remotes/origin/*      [branch "master"]              remote = origin              merge = refs/heads/masterIn the Github flow, the master branch is the frozen, current version of the software. Your master branch is always in sync with the upstream (our singularityware master), and the singularityware master is always the latest release ofThis would mean that I can update my master branch as follows:git checkout mastergit pull upstream mastergit push origin masterand then I would return to working on the branch for my feature. How to do that exactly? Read on!Step 3. Checkout a new branchBranches are a way of isolating your features. For example, if I am working on several features, I would want to keep them separate, and “submit them” (in what is called a pull request) to be added to the main repository codebase. Each repository, including your fork, has a main branch, which is usually called “master”. As mentioned earlier, the master branch of a fork should always be in sync with the repository it is forked from (which I usually refer to as “upstream”) and then branches of the fork consistently updated with that master. Given that we’ve just cloned the repo, we probably want to work off of the current development branch, which has the most up to date “next version” of the software. So we can start by checking out that branch:git checkout -b developmentgit pull origin developmentAt this point, you can either choose to work on this branch, push to your origin development and pull request to singularityware development, or you can checkout another branch specific to your feature. We recommend always working from, and staying in sync with development. The command below would checkout a branch called add/my-awesome-new-feature from development.# Checkout a new branch called add/my-awesome-featuregit checkout -b add/my-awesome-feature developmentThe addition of the -b argument tells git that we want to make a new branch. If I want to just change branches (for example back to master) I can do the same command without -b:# Change back to mastergit checkout masterNote that you should commit changes to the branch you are working on before changing branches, otherwise they would be lost. Github will give you a warning and prevent you from changing branches if this is the case, so don’t worry too much about it.Step 4. Make your changesOn your new branch, go nuts! Make changes, test them, and when you are happy with a bit of progress, commit the changes to the branch:git commit -aThis will open up a little window in your default text editor that you can write a message in the first line. This commit message is important - it should describe exactly the changes that you have made. Bad commit messages are like:  changed code  updated filesGood commit messages are like:  changed function “get_config” in functions.py to output csv to fix #2  updated docs about shell to close #10The tags “close #10” and “fix #2” are referencing issues that are posted on the main repo you are going to do a pull request to. Given that your fix is merged into the master branch, these messages will automatically close the issues, and further, it will link your commits directly to the issues they intended to fix. This is very important down the line if someone wants to understand your contribution, or (hopefully not) revert the code back to a previous version.Step 5. Push your branch to your forkWhen you are done with your commits, you should push your branch to your fork (and you can also continuously push commits here as you work):git push origin add/my-awesome-featureNote that you should always check the status of your branches to see what has been pushed (or not):git statusStep 6. Submit a Pull RequestOnce you have pushed your branch, then you can go to either fork and (in the GUI) submit a Pull Request. Regardless of the name of your branch, your PR should be submit to the singularityware development branch. This will open up a nice conversation interface / forum for the developers of Singularity to discuss your contribution, likely after testing. At this time, any continuous integration that is linked with the code base will also be run. If there is an issue, you can continue to push commits to your branch and it will update the Pull Request.Support, helping and spreading the word!This is a huge endavor, and it is greatly appreciated! If you have been using Singularity and having good luck with it, join our Google Group and help out other users! Post to online communities about Singularity, and request that your distribution vendor, service provider, and system administrators include Singularity for you!                Previous        Next                 Edit me                                                                                                                                                 Site last generated: Jul 26, 2017                             ">


<meta name="name" content="Contributing to Singularity">

<meta name="thumbnail" content="http://singularity.lbl.gov/images/logo/logo.svg">


<title>Contributing to Singularity | Singularity</title>
<link rel="stylesheet" href="assets/css/syntax.css">


<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="assets/css/modern-business.css">
<link rel="stylesheet" href="assets/css/lavish-bootstrap.css">
<link rel="stylesheet" href="assets/css/customstyles.css">
<link rel="stylesheet" href="assets/css/theme-blue.css">

<link rel="stylesheet" type="text/css" href="assets/css/asciinema-player.css" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="assets/js/jquery.navgoco.min.js"></script>


<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="assets/js/toc.js"></script>
<script src="assets/js/customscripts.js"></script>

<link rel="shortcut icon" href="images/favicon/favicon.ico">

<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->

<link rel="alternate" type="application/rss+xml" title="" href="http://localhost:4005feed.xml">

    <script>
        $(document).ready(function() {

            // Initialize navgoco with default options
            $("#mysidebar").navgoco({
                caretHtml: '',
                accordion: true,
                openClass: 'active', // open
                save: false, // leave false or nav highlighting doesn't work right
                cookie: {
                    name: 'navgoco',
                    expires: false,
                    path: '/'
                },
                slide: {
                    duration: 400,
                    easing: 'swing'
                }
            });

            $("#collapseAll").click(function(e) {
                e.preventDefault();
                $("#mysidebar").navgoco('toggle', false);
            });

            $("#expandAll").click(function(e) {
                e.preventDefault();
                $("#mysidebar").navgoco('toggle', true);
            });

        });

    </script>
    <script>
        $(function () {
            $('[data-toggle="tooltip"]').tooltip()
        })
    </script>
    

</head>
<body>
<!-- asciinema player -->
<script src="assets/js/asciinema-player.js"></script>

<!-- Show or hide players on button clicks-->
<script>
$( document ).ready(function() {
    $(".asciinema-button").click(function(){
        var asciinemaVideo = "#asciinema-" + $(this).attr('id');

        if ($(asciinemaVideo).hasClass('hidden')){
            $(asciinemaVideo).removeClass('hidden');
            $(this).text('Hide Tutorial')
        } else {
            $(asciinemaVideo).addClass('hidden');
            $(this).text('Show Tutorial')
        }
        
    });
});
</script>

<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container topnavlinks">
        <div class="navbar-header">
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> Singularity</span></a>
        </div>
        <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
            <ul class="nav navbar-nav navbar-right">
                <!-- entries without drop-downs appear here -->
                
                
                <li><a href="blog">News</a></li>
                
                
                <!-- entries with drop-downs appear here -->
                <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
                
                
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Docs<b class="caret"></b></a>
                    <ul class="dropdown-menu">
                        
                        
                        <li><a href="admin-guide">Admin Guide</a></li>
                        
                        
                        <li><a href="user-guide">User Guide</a></li>
                        
                        
                        <li><a href="links">Contributed Content</a></li>
                        
                        
                    </ul>
                </li>
                
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Quick Links<b class="caret"></b></a>
                    <ul class="dropdown-menu">
                        
                        
                        <li><a href="https://github.com/singularityware/singularity" target="_blank">Github Repo</a></li>
                        
                        
                        <li><a href="https://groups.google.com/a/lbl.gov/forum/#!forum/singularity" target="_blank">Google Group</a></li>
                        
                        
                        <li><a href="http://stackoverflow.com/questions/tagged/singularity" target="_blank">Singularity on Stack Overflow</a></li>
                        
                        
                        <li><a href="https://singularity-hub.org/faq" target="_blank">Singularity Hub</a></li>
                        
                        
                        <li><a href="https://singularity-container.slack.com" target="_blank">Slack</a></li>
                        
                        
                        <li><a href="faq#troubleshooting">Troubleshooting</a></li>
                        
                        
                    </ul>
                </li>
                
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">People<b class="caret"></b></a>
                    <ul class="dropdown-menu">
                        
                        
                        <li><a href="https://github.com/gmkurtzer" target="_blank">Gregory M. Kurtzer</a></li>
                        
                        
                        <li><a href="https://github.com/vsoch" target="_blank">Vanessa Sochat</a></li>
                        
                        
                        <li><a href="https://github.com/bauerm97" target="_blank">Michael Bauer</a></li>
                        
                        
                        <li><a href="https://github.com/bbockelm" target="_blank">Brian Bockelman</a></li>
                        
                        
                        <li><a href="https://github.com/singularityware/singularity/blob/master/AUTHORS" target="_blank">Complete Authors List</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li><a href="/search"><i class="fa fa-search"></i></li>
                <!-- jekyll search hidden in favor of google
                <li>
                    <div id="search-demo-container">
                        <input type="text" id="search-input" placeholder="search...">
                        <ul id="results-container"></ul>
                    </div>
                    <script src="assets/js/jekyll-search.js" type="text/javascript"></script>
                    <script type="text/javascript">
                            SimpleJekyllSearch.init({
                                searchInput: document.getElementById('search-input'),
                                resultsContainer: document.getElementById('results-container'),
                                dataSource: 'search.json',
                                searchResultTemplate: '<li><a href="{url}" title="Contributing to Singularity">{title}</a></li>',
                    noResultsText: 'No results found.',
                            limit: 10,
                            fuzzy: true,
                    })
                    </script>
                    end search-->
                </li>
            </ul>
        </div>
        </div>
        <!-- /.container -->
</nav>

<!-- Page Content -->
<div class="container">
    <div class="col-lg-12">&nbsp;</div>
    <!-- Content Row -->
    <div class="row">
        <!-- Sidebar Column -->
        <div class="col-md-3">
          

<div class="shiny"><a href="\"><figure><img src="/images/logo/logo.svg" class="sidebar-logo"/></figure></a></div>


<ul id="mysidebar" class="nav">
    <li class="sidebarTitle">Singularity</li>
    
    
    <li>
        <a href="#">Information</a>
        <ul>
            
            
            <li><a href="blog">News</a></li>
            
            
            <li><a href="about">About Singularity</a></li>
            
            
            <li><a href="presentations">Presentations</a></li>
            
            
            <li><a href="citation-registration">Registry: Citations and Installations</a></li>
            
            
        </ul>
        
        
    <li>
        <a href="#">Download / Installation</a>
        <ul>
            
            
            <li><a href="all-releases">All Releases</a></li>
            
            
            <li><a href="install-linux">Install Singularity on Linux</a></li>
            
            
            <li><a href="install-mac">Install Singularity on Mac</a></li>
            
            
            <li><a href="install-windows">Install Singularity on Windows</a></li>
            
            
        </ul>
        
        
    <li>
        <a href="#">Contributing</a>
        <ul>
            
            
            <li><a href="contributing-support">User Support</a></li>
            
            
            <li class="active"><a href="contributing-code">Code Development</a></li>
            
            
            <li><a href="contributing-docs">Writing Documentation</a></li>
            
            
        </ul>
        
        
    <li>
        <a href="#">Getting Help</a>
        <ul>
            
            
            <li><a href="faq">FAQ</a></li>
            
            
            <li><a href="support">Support</a></li>
            
            
            <li><a href="faq#troubleshooting">Troubleshooting</a></li>
            
            
        </ul>
        
        
    <li>
        <a href="#">Documentation</a>
        <ul>
            
            
            <li><a href="quickstart">Quick Start</a></li>
            
            
            <li><a href="tutorials">Recipes and Tutorials</a></li>
            
            
            <li><a href="links">Contributed Content Links</a></li>
            
            
            <li><a href="user-guide">User Documentation</a></li>
            
            
            <li><a href="admin-guide">Admin Documentation</a></li>
            
            
        </ul>
        
        
        <!-- if you aren't using the accordion, uncomment this block:
           <p class="external">
               <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
           </p>
           -->
    </li>
</ul>
</div>

<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>

    <!-- Content Column -->
    <div class="col-md-9">
        <div class="post-header">
   <h1 class="post-title-main">Contributing to Singularity</h1>
</div>


<div class="post-content">

   
    <!-- Previous and next buttons-->
    <div class="row" style="padding-top:30px; margin-bottom:10px"><div class="col-md-12">
        <a href="#"><button style="float:left" class="hidden previous-button btn btn-circle btn-default"><i class="fa-2x fa fa-angle-double-left"></i></button></a>
        <a href="#"><button style="float:right" class="hidden next-button btn btn-circle btn-default"><i class="fa fa-angle-double-right fa-2x"></i></button></a>
    </div></div>

    <script>
    $(document).ready(function(){

        var next = $("li.active").next().last().find('a').attr('href');
        var previous = $("li.active").prev().last().find('a').attr('href');

        // NEXT BUTTON
        if (typeof next == 'undefined'){
            console.log("disabling next button")
            $(".next-button").addClass("hidden")
        } else if (next == "#") {
            next = $("li.active").next().find("li").first().find('a').attr('href');
            $(".next-button").closest('a').attr('href', next)
            $(".next-button").removeClass('hidden')
        } else {
            $(".next-button").closest('a').attr('href', next)
            $(".next-button").removeClass('hidden')
        }

        // PREVIOUS BUTTON
        if (typeof previous == 'undefined'){
            console.log("disabling previous button")
            $(".previous-button").addClass("hidden")
        } else if (previous == "#") {
            previous = $("li.active").prev().find("li").last().find('a').attr('href')
            $(".previous-button").closest('a').attr('href', previous)
            $(".previous-button").removeClass('hidden')
        } else {
            $(".previous-button").closest('a').attr('href', previous)
            $(".previous-button").removeClass('hidden')
        }

    })
    </script>

    
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
  // Handler for .ready() called.

$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });

/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
  var target = $(this.getAttribute('href'))
    , scroll_target = target.offset().top

  $(window).scrollTop(scroll_target - 10);
  return false
})
  
});
</script>

<div id="toc"></div>

    
  <h2 id="contribute-to-the-code">Contribute to the code</h2>

<p>To contribute to the development of Singularity, you must:</p>

<ul>
  <li>Own the code and/or have the right to contribute it</li>
  <li>Be able to submit software under the 3 clause BSD (or equivalent) license (while other licenses are allowed to be submitted by the license, acceptance of any contribution is up to the project lead)</li>
  <li>Read, understand and agree to the license</li>
  <li>Have a GitHub account (this just makes it easier on me)</li>
</ul>

<p>We use the traditional <a href="https://guides.github.com/introduction/flow/" target="_blank">Github Flow</a> to develop. This means that you fork the repo and checkout a branch to make changes, you submit a pull request (PR) to the development branch with your changes, and the development branch gets merged with master for official releases. We also have an official <a href="https://github.com/singularityware/singularity/blob/master/CONTRIBUTING.md" target="_blank">CONTRIBUTING</a> document, which also includes a <a href="https://github.com/singularityware/singularity/blob/master/CONTRIBUTING.md#code-of-conduct" target="_blank">code of conduct</a>.</p>

<h3 id="step-1-fork-the-repo">Step 1. Fork the repo</h3>
<p>To contribute to the web based documentation, you should obtain a GitHub account and fork the <a href="https://github.com/singularityware/singularity" target="_blank">Singularity</a> repository. Once forked, you will want to clone the fork of the repo to your computer. Let’s say my Github username is vsoch, and I am using ssh:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git clone git@github.com:vsoch/singularity.git
<span class="nb">cd </span>singularity/
</code></pre>
</div>

<h3 id="step-2-set-up-your-config">Step 2. Set up your config</h3>
<p>The github config file, located at <code class="highlighter-rouge">.git/config</code>, is the best way to keep track of many different forks of a repository. I usually open it up right after cloning my fork to add the repository that I forked as a <a href="https://help.github.com/articles/adding-a-remote/" target="_blank">remote</a>, so I can easily get updated from it. Let’s say my .git/config first looks like this, after I clone my own branch:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>      <span class="o">[</span>core]
              repositoryformatversion <span class="o">=</span> 0
              filemode <span class="o">=</span> <span class="nb">true
              </span>bare <span class="o">=</span> <span class="nb">false
              </span>logallrefupdates <span class="o">=</span> <span class="nb">true</span>
      <span class="o">[</span>remote <span class="s2">"origin"</span><span class="o">]</span>
              url <span class="o">=</span> git@github.com:vsoch/singularity
              fetch <span class="o">=</span> +refs/heads/<span class="k">*</span>:refs/remotes/origin/<span class="k">*</span>
      <span class="o">[</span>branch <span class="s2">"master"</span><span class="o">]</span>
              remote <span class="o">=</span> origin
              merge <span class="o">=</span> refs/heads/master
</code></pre>
</div>

<p>I would want to add the upstream repository, which is where I forked from.</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>      <span class="o">[</span>core]
              repositoryformatversion <span class="o">=</span> 0
              filemode <span class="o">=</span> <span class="nb">true
              </span>bare <span class="o">=</span> <span class="nb">false
              </span>logallrefupdates <span class="o">=</span> <span class="nb">true</span>
      <span class="o">[</span>remote <span class="s2">"origin"</span><span class="o">]</span>
              url <span class="o">=</span> git@github.com:vsoch/singularity
              fetch <span class="o">=</span> +refs/heads/<span class="k">*</span>:refs/remotes/origin/<span class="k">*</span>
      <span class="o">[</span>remote <span class="s2">"upstream"</span><span class="o">]</span>
              url <span class="o">=</span> https://github.com/singularityware/singularity
              fetch <span class="o">=</span> +refs/heads/<span class="k">*</span>:refs/remotes/origin/<span class="k">*</span>
      <span class="o">[</span>branch <span class="s2">"master"</span><span class="o">]</span>
              remote <span class="o">=</span> origin
              merge <span class="o">=</span> refs/heads/master
</code></pre>
</div>

<p>I can also add some of my colleagues, if I want to pull from their branches:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>      <span class="o">[</span>core]
              repositoryformatversion <span class="o">=</span> 0
              filemode <span class="o">=</span> <span class="nb">true
              </span>bare <span class="o">=</span> <span class="nb">false
              </span>logallrefupdates <span class="o">=</span> <span class="nb">true</span>
      <span class="o">[</span>remote <span class="s2">"origin"</span><span class="o">]</span>
              url <span class="o">=</span> git@github.com:vsoch/singularity
              fetch <span class="o">=</span> +refs/heads/<span class="k">*</span>:refs/remotes/origin/<span class="k">*</span>
      <span class="o">[</span>remote <span class="s2">"upstream"</span><span class="o">]</span>
              url <span class="o">=</span> https://github.com/singularityware/singularity
              fetch <span class="o">=</span> +refs/heads/<span class="k">*</span>:refs/remotes/origin/<span class="k">*</span>
      <span class="o">[</span>remote <span class="s2">"greg"</span><span class="o">]</span>
              url <span class="o">=</span> https://github.com/gmkurtzer/singularity
              fetch <span class="o">=</span> +refs/heads/<span class="k">*</span>:refs/remotes/origin/<span class="k">*</span>
      <span class="o">[</span>branch <span class="s2">"master"</span><span class="o">]</span>
              remote <span class="o">=</span> origin
              merge <span class="o">=</span> refs/heads/master

</code></pre>
</div>

<p>In the Github flow, the master branch is the frozen, current version of the software. Your master branch is always in sync with the upstream (our singularityware master), and the singularityware master is always the latest release of</p>

<p>This would mean that I can update my master branch as follows:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git checkout master
git pull upstream master
git push origin master
</code></pre>
</div>
<p>and then I would return to working on the branch for my feature. How to do that exactly? Read on!</p>

<h3 id="step-3-checkout-a-new-branch">Step 3. Checkout a new branch</h3>
<p><a href="https://guides.github.com/introduction/flow/" target="_blank">Branches</a> are a way of isolating your features. For example, if I am working on several features, I would want to keep them separate, and “submit them” (in what is called a <a href="https://help.github.com/articles/about-pull-requests/" target="_blank">pull request</a>) to be added to the main repository codebase. Each repository, including your fork, has a main branch, which is usually called “master”. As mentioned earlier, the master branch of a fork should always be in sync with the repository it is forked from (which I usually refer to as “upstream”) and then branches of the fork consistently updated with that master. Given that we’ve just cloned the repo, we probably want to work off of the current development branch, which has the most up to date “next version” of the software. So we can start by checking out that branch:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git checkout -b development
git pull origin development
</code></pre>
</div>

<p>At this point, you can either choose to work on this branch, push to your origin development and pull request to singularityware development, or you can checkout another branch specific to your feature. We recommend always working from, and staying in sync with development. The command below would checkout a branch called <code class="highlighter-rouge">add/my-awesome-new-feature</code> from development.</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c"># Checkout a new branch called add/my-awesome-feature</span>
git checkout -b add/my-awesome-feature development
</code></pre>
</div>

<p>The addition of the <code class="highlighter-rouge">-b</code> argument tells git that we want to make a new branch. If I want to just change branches (for example back to master) I can do the same command without <code class="highlighter-rouge">-b</code>:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c"># Change back to master</span>
git checkout master
</code></pre>
</div>

<p>Note that you should commit changes to the branch you are working on before changing branches, otherwise they would be lost. Github will give you a warning and prevent you from changing branches if this is the case, so don’t worry too much about it.</p>

<h3 id="step-4-make-your-changes">Step 4. Make your changes</h3>
<p>On your new branch, go nuts! Make changes, test them, and when you are happy with a bit of progress, commit the changes to the branch:</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git commit -a
</code></pre>
</div>

<p>This will open up a little window in your default text editor that you can write a message in the first line. This commit message is important - it should describe exactly the changes that you have made. Bad commit messages are like:</p>

<ul>
  <li>changed code</li>
  <li>updated files</li>
</ul>

<p>Good commit messages are like:</p>

<ul>
  <li>changed function “get_config” in functions.py to output csv to fix #2</li>
  <li>updated docs about shell to close #10</li>
</ul>

<p>The tags “close #10” and “fix #2” are referencing issues that are posted on the main repo you are going to do a pull request to. Given that your fix is merged into the master branch, these messages will automatically close the issues, and further, it will link your commits directly to the issues they intended to fix. This is very important down the line if someone wants to understand your contribution, or (hopefully not) revert the code back to a previous version.</p>

<h3 id="step-5-push-your-branch-to-your-fork">Step 5. Push your branch to your fork</h3>
<p>When you are done with your commits, you should push your branch to your fork (and you can also continuously push commits here as you work):</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git push origin add/my-awesome-feature
</code></pre>
</div>

<p>Note that you should always check the status of your branches to see what has been pushed (or not):</p>

<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git status
</code></pre>
</div>

<h3 id="step-6-submit-a-pull-request">Step 6. Submit a Pull Request</h3>

<p>Once you have pushed your branch, then you can go to either fork and (in the GUI) <a href="https://help.github.com/articles/creating-a-pull-request/" target="_blank">submit a Pull Request</a>. Regardless of the name of your branch, your PR should be submit to the singularityware development branch. This will open up a nice conversation interface / forum for the developers of Singularity to discuss your contribution, likely after testing. At this time, any continuous integration that is linked with the code base will also be run. If there is an issue, you can continue to push commits to your branch and it will update the Pull Request.</p>

<h2 id="support-helping-and-spreading-the-word">Support, helping and spreading the word!</h2>
<p>This is a huge endavor, and it is greatly appreciated! If you have been using Singularity and having good luck with it, join our <a href="https://groups.google.com/a/lbl.gov/forum/#!forum/singularity" target="_blank">Google Group</a> and help out other users! Post to online communities about Singularity, and request that your distribution vendor, service provider, and system administrators include Singularity for you!</p>


    <!-- More navigation on the bottom -->
    <div class="row" style="padding-top:30px; margin-bottom:10px"><div class="col-md-12">
        <a href="#"><button style="width:20%; height: 70px; float:left" class="hidden previous-button btn btn-lg btn-default">Previous</button></a>
        <a href="#"><button style="width:20%; height: 70px; float:right" class="hidden next-button btn btn-lg btn-default">Next</button></a>
    </div></div>


    <a style="margin-top:10px;margin-bottom:10px" target="_blank" href="https://github.com/singularityware/singularityware.github.io/blob/master/pages/_pages/docs/contributing-code.md" class="btn btn-default btn-xs githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
    

    <div class="tags">
        
    </div>

    
</div>

<hr class="shaded"/>

<footer>
            <div class="row">

               <!-- Social Media links, etc -->
               <div class="col-lg-6 footer">
               
    <a class="no-after social-icon" href="https://twitter.com/SingularityApp">
      <i class="fa fa-4x fa-twitter no-after"></i>
    </a>


    <a class="no-after social-icon" href="https://github.com/singularityware">
      <i class="fa fa-4x fa-github no-after"></i>
    </a>


               </div>

                <div class="col-lg-6 footer">
<p><img src="images/logo/logo.png" alt="Company logo" style="width:40px;padding-bottom:10px"/></p>
 Site last generated: Jul 26, 2017 <br />
                </div>
            </div>
</footer>


    </div>
    <!-- /.row -->
</div>
<!-- /.container -->
    </div>

</body>

<!-- the google_analytics_id gets auto inserted from the config file -->


<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create','UA-84672381-1','auto');ga('require','displayfeatures');ga('send','pageview');</script>


</html>