Blame docs/html/contributing.html

Packit ea1746
Packit ea1746
Packit ea1746
Packit ea1746
Packit ea1746
 <html class="no-js" lang="en" > 
Packit ea1746
<head>
Packit ea1746
  <meta charset="utf-8">
Packit ea1746
  
Packit ea1746
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
Packit ea1746
  
Packit ea1746
  <title>Contributing — Ceres Solver</title>
Packit ea1746
  
Packit ea1746
Packit ea1746
  
Packit ea1746
  
Packit ea1746
Packit ea1746
  
Packit ea1746
Packit ea1746
  
Packit ea1746
  
Packit ea1746
    
Packit ea1746
Packit ea1746
  
Packit ea1746
Packit ea1746
  
Packit ea1746
  
Packit ea1746
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
Packit ea1746
  
Packit ea1746
Packit ea1746
  
Packit ea1746
Packit ea1746
  
Packit ea1746
    <link rel="top" title="Ceres Solver" href="index.html"/>
Packit ea1746
        <link rel="next" title="Version History" href="version_history.html"/>
Packit ea1746
        <link rel="prev" title="Users" href="users.html"/> 
Packit ea1746
Packit ea1746
  
Packit ea1746
  <script src="_static/js/modernizr.min.js"></script>
Packit ea1746
Packit ea1746
</head>
Packit ea1746
Packit ea1746
<body class="wy-body-for-nav" role="document">
Packit ea1746
Packit ea1746
  
Packit ea1746
Packit ea1746
    
Packit ea1746
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
Packit ea1746
      
Packit ea1746
        
Packit ea1746
          
Packit ea1746
Packit ea1746
          
Packit ea1746
             Ceres Solver
Packit ea1746
          
Packit ea1746
Packit ea1746
          
Packit ea1746
          
Packit ea1746
Packit ea1746
          
Packit ea1746
            
Packit ea1746
            
Packit ea1746
              
Packit ea1746
                1.13
Packit ea1746
              
Packit ea1746
            
Packit ea1746
          
Packit ea1746
Packit ea1746
          
Packit ea1746
Packit ea1746
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Packit ea1746
    <input type="text" name="q" placeholder="Search docs" />
Packit ea1746
    <input type="hidden" name="check_keywords" value="yes" />
Packit ea1746
    <input type="hidden" name="area" value="default" />
Packit ea1746
  </form>
Packit ea1746
Packit ea1746
Packit ea1746
          
Packit ea1746
        
Packit ea1746
Packit ea1746
        
Packit ea1746
          
Packit ea1746
            
Packit ea1746
            
Packit ea1746
                
    Packit ea1746
  • Why?
  • Packit ea1746
  • Installation
  • Packit ea1746
  • Tutorial
  • Packit ea1746
  • On Derivatives
  • Packit ea1746
  • Modeling Non-linear Least Squares
  • Packit ea1746
  • Solving Non-linear Least Squares
  • Packit ea1746
  • Covariance Estimation
  • Packit ea1746
  • General Unconstrained Minimization
  • Packit ea1746
  • FAQS, Tips & Tricks
  • Packit ea1746
  • Users
  • Packit ea1746
  • Contributing
    • Packit ea1746
    • Setting up your Environment
    • Packit ea1746
    • Submitting a change
    • Packit ea1746
      Packit ea1746
      Packit ea1746
    • Version History
    • Packit ea1746
    • Bibliography
    • Packit ea1746
    • License
    • Packit ea1746
      Packit ea1746
      Packit ea1746
                  
      Packit ea1746
                
      Packit ea1746
              
      Packit ea1746
            
      Packit ea1746
          </nav>
      Packit ea1746
      Packit ea1746
          <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
      Packit ea1746
      Packit ea1746
            
      Packit ea1746
            <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
      Packit ea1746
              
      Packit ea1746
              Ceres Solver
      Packit ea1746
            </nav>
      Packit ea1746
      Packit ea1746
      Packit ea1746
            
      Packit ea1746
            
      Packit ea1746
              
      Packit ea1746
                
      Packit ea1746
      Packit ea1746
       
      Packit ea1746
      Packit ea1746
      Packit ea1746
      Packit ea1746
      Packit ea1746
        
        Packit ea1746
            
      • Docs »
      • Packit ea1746
              
        Packit ea1746
            
      • Contributing
      • Packit ea1746
              
      • Packit ea1746
                
        Packit ea1746
                  
        Packit ea1746
                
        Packit ea1746
              
        Packit ea1746
          
        Packit ea1746
          
        Packit ea1746
        Packit ea1746
                  
        Packit ea1746
                   
        Packit ea1746
                    
        Packit ea1746
          
        Packit ea1746

        Contributing

        Packit ea1746

        We welcome contributions to Ceres, whether they are new features, bug

        Packit ea1746
        fixes or tests. The Ceres mailing list is the best place
        Packit ea1746
        for all development related discussions. Please consider joining
        Packit ea1746
        it. If you have ideas on how you would like to contribute to Ceres, it
        Packit ea1746
        is a good idea to let us know on the mailing list before you start
        Packit ea1746
        development. We may have suggestions that will save effort when trying
        Packit ea1746
        to merge your work into the main branch. If you are looking for ideas,
        Packit ea1746
        please let us know about your interest and skills and we will be happy
        Packit ea1746
        to make a suggestion or three.

        Packit ea1746

        We follow Google’s C++ Style Guide and

        Packit ea1746
        use git for version control. We use the
        Packit ea1746
        Gerrit to collaborate and
        Packit ea1746
        review changes to Ceres. Gerrit enables pre-commit reviews so that
        Packit ea1746
        Ceres can maintain a linear history with clean, reviewed commits, and
        Packit ea1746
        no merges.

        Packit ea1746

        We now describe how to set up your development environment and submit

        Packit ea1746
        a change list for review via Gerrit.

        Packit ea1746
        Packit ea1746

        Setting up your Environment

        Packit ea1746
          Packit ea1746
        1. Download and configure git.

        2. Packit ea1746
            Packit ea1746
          • Mac brew install git.
          • Packit ea1746
          • Linux sudo apt-get install git.
          • Packit ea1746
          • Windows. Download msysgit, which includes a minimal
          • Packit ea1746
            Cygwin install.
            Packit ea1746
            Packit ea1746
            Packit ea1746
          • Sign up for Gerrit. You will also

          • Packit ea1746
            need to sign the Contributor License Agreement (CLA) with Google,
            Packit ea1746
            which gives Google a royalty-free unlimited license to use your
            Packit ea1746
            contributions. You retain copyright.

            Packit ea1746
            Packit ea1746
          • Clone the Ceres Solver git repository from Gerrit.

          • Packit ea1746
            git clone https://ceres-solver.googlesource.com/ceres-solver