contribute_to_paddle_cn.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>如何贡献代码 &mdash; PaddlePaddle  文档</title>
  

    <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="索引"
              href="../../genindex.html"/>
        <link rel="search" title="搜索" href="../../search.html"/>
    <link rel="top" title="PaddlePaddle  文档" href="../../index.html"/>
        <link rel="up" title="进阶指南" href="../index_cn.html"/>
        <link rel="next" title="RNN相关模型" href="../deep_model/rnn/index_cn.html"/>
        <link rel="prev" title="如何贡献/修改文档" href="write_docs_cn.html"/> 

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/css/perfect-scrollbar.min.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/css/override.css" type="text/css" />
  <script>
  var _hmt = _hmt || [];
  (function() {
    var hm = document.createElement("script");
    hm.src = "//hm.baidu.com/hm.js?b9a314ab40d04d805655aab1deee08ba";
    var s = document.getElementsByTagName("script")[0]; 
    s.parentNode.insertBefore(hm, s);
  })();
  </script>

  
  <script src="../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  
  <header class="site-header">
    <div class="site-logo">
      <a href="/"><img src="../../_static/images/PP_w.png"></a>
    </div>
    <div class="site-nav-links">
      <div class="site-menu">
        <a class="fork-on-github" href="https://github.com/PaddlePaddle/Paddle" target="_blank"><i class="fa fa-github"></i>Folk me on Github</a>
        <div class="language-switcher dropdown">
          <a type="button" data-toggle="dropdown">
            <span>English</span>
            <i class="fa fa-angle-up"></i>
            <i class="fa fa-angle-down"></i>
          </a>
          <ul class="dropdown-menu">
            <li><a href="/doc_cn">中文</a></li>
            <li><a href="/doc">English</a></li>
          </ul>
        </div>
        <ul class="site-page-links">
          <li><a>Home</a></li>
          <li><a>Get Started</a></li>
          <li class="active"><a>Documentation</a></li>
          <li><a>About Us</a></li>
        </ul>
      </div>
      <div class="doc-module">
        
        <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../getstarted/index_cn.html">新手入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/index_cn.html">完整教程</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index_cn.html">进阶指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api/index_cn.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/index_cn.html">FAQ</a></li>
</ul>

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>        
      </div>
    </div>
  </header>
  
  <div class="main-content-wrap">

    
    <nav class="doc-menu-vertical" role="navigation">
        
          
          <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../getstarted/index_cn.html">新手入门</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../getstarted/build_and_install/index_cn.html">安装与编译</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../getstarted/build_and_install/docker_install_cn.html">PaddlePaddle的Docker容器使用方式</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../getstarted/build_and_install/ubuntu_install_cn.html">Ubuntu部署PaddlePaddle</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../getstarted/build_and_install/cmake/build_from_source_cn.html">PaddlePaddle的编译选项</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../getstarted/basic_usage/index_cn.html">经典的线性回归任务</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/index_cn.html">完整教程</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/quick_start/index_cn.html">快速入门</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/rec/ml_regression_cn.html">个性化推荐</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/image_classification/index_cn.html">图像分类</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/sentiment_analysis/index_cn.html">情感分析</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/semantic_role_labeling/index_cn.html">语义角色标注</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/text_generation/index_cn.html">机器翻译</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/imagenet_model/resnet_model_cn.html">ResNet模型</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/embedding_model/index_cn.html">词向量模型</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../index_cn.html">进阶指南</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../usage/cmd_parameter/index_cn.html">设置命令行参数</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../usage/cmd_parameter/use_case_cn.html">使用案例</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage/cmd_parameter/arguments_cn.html">参数概述</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage/cmd_parameter/detail_introduction_cn.html">细节描述</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../usage/concepts/use_concepts_cn.html">基本使用概念</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/cluster/cluster_train_cn.html">运行分布式训练</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/k8s/k8s_basis_cn.html">Kubernetes 简介</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/k8s/k8s_basis_cn.html#kubernetes">部署Kubernetes集群</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/k8s/k8s_basis_cn.html#">选择存储方案</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/k8s/k8s_basis_cn.html#kubectl">配置kubectl</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/k8s/k8s_cn.html">Kubernetes单机训练</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/k8s/k8s_distributed_cn.html">Kubernetes分布式训练</a></li>
<li class="toctree-l2"><a class="reference internal" href="write_docs_cn.html">如何贡献/修改文档</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">如何贡献代码</a></li>
<li class="toctree-l2"><a class="reference internal" href="../deep_model/rnn/index_cn.html">RNN相关模型</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../deep_model/rnn/rnn_config_cn.html">RNN配置</a></li>
<li class="toctree-l3"><a class="reference internal" href="../deep_model/rnn/recurrent_group_cn.html">Recurrent Group教程</a></li>
<li class="toctree-l3"><a class="reference internal" href="../deep_model/rnn/hierarchical_layer_cn.html">支持双层序列作为输入的Layer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../deep_model/rnn/hrnn_rnn_api_compare_cn.html">单双层RNN API对比介绍</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../optimization/gpu_profiling_cn.html">GPU性能分析与调优</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api/index_cn.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../api/v2/model_configs.html">模型配置</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/v2/config/activation.html">Activation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/v2/config/layer.html">Layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/v2/config/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/v2/config/pooling.html">Pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/v2/config/networks.html">Networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/v2/config/attr.html">Parameter Attribute</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/v2/data.html">数据访问</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/v2/run_logic.html">训练与应用</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/index_cn.html">FAQ</a></li>
</ul>

        
    </nav>
    
    <nav class="local-toc"><ul>
<li><a class="reference internal" href="#">如何贡献代码</a><ul>
<li><a class="reference internal" href="#">代码要求</a></li>
<li><a class="reference internal" href="#fork">Fork</a></li>
<li><a class="reference internal" href="#clone">克隆（Clone）</a></li>
<li><a class="reference internal" href="#pre-commit">使用 <code class="docutils literal"><span class="pre">pre-commit</span></code> 钩子</a></li>
<li><a class="reference internal" href="#commit">提交（Commit）</a></li>
<li><a class="reference internal" href="#fork">保持 Fork 状态最新</a></li>
<li><a class="reference internal" href="#push-github">推送（Push）到 GitHub</a></li>
<li><a class="reference internal" href="#pull-request">拉取请求（Pull Request）</a></li>
<li><a class="reference internal" href="#pull">使用最新版本更新你的 pull 请求</a></li>
<li><a class="reference internal" href="#pull-request">修改你的 pull request</a></li>
</ul>
</li>
</ul>
</nav>
    
    <section class="doc-content-wrap">

      
<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
      
        <li><a href="../index_cn.html">进阶指南</a> > </li>
      
    <li>如何贡献代码</li>
  </ul>
</div>
      
      <div class="wy-nav-content" id="doc-content">
        <div class="rst-content">
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="">
<span id="id1"></span><h1>如何贡献代码<a class="headerlink" href="#" title="永久链接至标题">¶</a></h1>
<p>我们真诚地感谢您的贡献，欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。</p>
<div class="section" id="">
<span id="id2"></span><h2>代码要求<a class="headerlink" href="#" title="永久链接至标题">¶</a></h2>
<ul class="simple">
<li>你的代码必须完全遵守 <a class="reference external" href="http://www.stack.nl/~dimitri/doxygen/">doxygen</a> 的样式。</li>
<li>确保编译器选项 WITH_STYLE_CHECK 已打开，并且编译能通过代码样式检查。</li>
<li>所有代码必须具有单元测试。</li>
<li>通过所有单元测试。</li>
</ul>
<p>以下教程将指导您提交代码。</p>
</div>
<div class="section" id="fork">
<span id="fork"></span><h2><a class="reference external" href="https://help.github.com/articles/fork-a-repo/">Fork</a><a class="headerlink" href="#fork" title="永久链接至标题">¶</a></h2>
<p>跳转到<a class="reference external" href="https://github.com/PaddlePaddle/Paddle">PaddlePaddle</a> GitHub首页，然后单击 <code class="docutils literal"><span class="pre">Fork</span></code> 按钮。</p>
</div>
<div class="section" id="clone">
<span id="clone"></span><h2>克隆（Clone）<a class="headerlink" href="#clone" title="永久链接至标题">¶</a></h2>
<p>Paddle 目前使用<a class="reference external" href="http://nvie.com/posts/a-successful-git-branching-model/">git流分支模型</a>进行开发，测试，发行和维护。
<strong>develop</strong> 是主分支，其他用户分支是特征分支（feature branches）。</p>
<p>一旦你创建了一个fork，你可以使用你最喜欢的 git 客户端克隆你的仓库（repo）或只是直接在命令行输入：</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span><span class="c1"># 克隆 fork 到本地</span>
git clone --branch develop https://github.com/USERNAME/Paddle.git
</pre></div>
</div>
<p>如果你的仓库不包含 <strong>develop</strong> 分支，你只需自己创建它。</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>git clone https://github.com/USERNAME/Paddle.git Paddle
<span class="nb">cd</span> Paddle
git checkout -b develop  <span class="c1"># 创建 develop 分支</span>
git remote add upstream https://github.com/PaddlePaddle/Paddle.git  <span class="c1"># 添加 upstream 到 baidu/Paddle</span>
git pull upstream develop  <span class="c1"># 更新 upstream</span>
</pre></div>
</div>
<p>然后你可以通过做一个本地开发分支开始开发</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>git checkout -b MY_COOL_STUFF_BRANCH
</pre></div>
</div>
</div>
<div class="section" id="pre-commit">
<span id="pre-commit"></span><h2>使用 <code class="docutils literal"><span class="pre">pre-commit</span></code> 钩子<a class="headerlink" href="#pre-commit" title="永久链接至标题">¶</a></h2>
<p>Paddle 开发人员使用 <a class="reference external" href="http://pre-commit.com/">pre-commit</a> 工具来管理git预提交钩子。 它可以帮助我们格式化源代码（cpp，python），在提交前检查一些基本事宜（每个文件只有一个 EOL
，git 中不要添加大文件）。 <code class="docutils literal"><span class="pre">pre-commit</span></code>测试是 Travis-CI 中单元测试的一部分，不满足钩子
的 PR 不能提交代码到 Paddle。</p>
<p>你可以通过 <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pre-commit</span></code> 安装 <a class="reference external" href="http://pre-commit.com/">pre-commit</a>，
目前 Paddle 使用 <code class="docutils literal"><span class="pre">clang-format</span></code> 来调整C/C++源代码格式。请确保 clang-format 版本在3.8以上。</p>
<p>然后只需在 Paddle clone 目录中运行 <code class="docutils literal"><span class="pre">pre-commit</span> <span class="pre">install</span></code> 。当你
提交你的代码时，pre-commit 钩子会检查本地代码是否存在
不适合提交的东西，等等。</p>
</div>
<div class="section" id="commit">
<span id="commit"></span><h2>提交（Commit）<a class="headerlink" href="#commit" title="永久链接至标题">¶</a></h2>
<p>提交你的代码：</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span><span class="c1"># 显示工作树状态</span>
git status
<span class="c1"># 添加修改过的文件</span>
git add xx
env <span class="nv">EDITOR</span><span class="o">=</span>vim git commit  <span class="c1"># 你可以用 vim/nano/emacs 写下你的注释</span>
</pre></div>
</div>
<p>提交信息的第一行是标题，其他行可以添加一些细节（如果有必要的话）。</p>
</div>
<div class="section" id="fork">
<span id="id3"></span><h2>保持 Fork 状态最新<a class="headerlink" href="#fork" title="永久链接至标题">¶</a></h2>
<p>在拉（pull）你的请求（request）之前，你应该从最新的 PaddlePaddle 同步代码。
为此，你需要首先添加远程（remote）：</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span><span class="c1"># 观察当前远程仓库配置</span>
git remote -v
<span class="c1"># 添加上游（upstream）仓库</span>
git remote add upstream https://github.com/PaddlePaddle/Paddle.git
<span class="c1"># 验证新的 upstream</span>
git remote -v
</pre></div>
</div>
<p>用最新的 upstream 更新你的 fork：</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>git pull --rebase upstream develop
</pre></div>
</div>
<p>如果本地没有提交，git 将简单地执行快进。但是，如果你一直在做一些改变（绝大多数情况下不应该），你可能要处理冲突。</p>
<p>现在，你的本地主分支与上游修改的一致并是最新的。</p>
</div>
<div class="section" id="push-github">
<span id="push-github"></span><h2>推送（Push）到 GitHub<a class="headerlink" href="#push-github" title="永久链接至标题">¶</a></h2>
<div class="highlight-shell"><div class="highlight"><pre><span></span><span class="c1"># 在 GitHub 上 push 你的仓库</span>
git push -u origin MY_COOL_STUFF_BRANCH  <span class="c1"># 创建远程分支 MY_COOL_STUFF_BRANCH 到 origin.</span>
</pre></div>
</div>
</div>
<div class="section" id="pull-request">
<span id="pull-request"></span><h2>拉取请求（Pull Request）<a class="headerlink" href="#pull-request" title="永久链接至标题">¶</a></h2>
<p>转到 GitHub上 你 fork 的页面，选择你的开发分支并单击 <strong>pull request 按钮</strong>。</p>
</div>
<div class="section" id="pull">
<span id="pull"></span><h2>使用最新版本更新你的 pull 请求<a class="headerlink" href="#pull" title="永久链接至标题">¶</a></h2>
<p>在代码审查（code review）期间，由于 baidu/Paddle 中新的提交导致你的 pull 请求可能会失效。如果没有冲突，GitHub允许自动更新。 你可以点击 pull request 页面中的“更新分支（Update Branch）”按钮。 但是如果存在代码冲突，你需要手动进行更新。你需要在本地仓库执行如下命令：</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>git checkout MY_COOL_STUFF_BRANCH
git pull upstream develop
<span class="c1"># 你可能需要根据git提示解决冲突</span>
<span class="c1"># 创建并测试你的代码</span>
git push origin MY_COOL_STUFF_BRANCH
</pre></div>
</div>
<p>现在你的 Pull Request 是最新的了。</p>
</div>
<div class="section" id="pull-request">
<span id="id4"></span><h2>修改你的 pull request<a class="headerlink" href="#pull-request" title="永久链接至标题">¶</a></h2>
<p>当根据审阅者的意见修改 pull 请求时，请使用“git commit”而不是“git commit &#8211;amend”来提交更改，以便审阅者可以看到新的请求和旧的请求之间的区别。</p>
<p>可能的命令是</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>git checkout MY_COOL_STUFF_BRANCH
git pull upstream develop   <span class="c1"># 将本地更新到最新的代码库</span>
<span class="c1"># 可能会发生一些冲突</span>
<span class="c1"># 开始开发吧！</span>
env <span class="nv">EDITOR</span><span class="o">=</span>vim git commit  <span class="c1"># 添加修改日志</span>
git push origin MY_COOL_STUFF_BRANCH
</pre></div>
</div>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../deep_model/rnn/index_cn.html" class="btn btn-neutral float-right" title="RNN相关模型" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="write_docs_cn.html" class="btn btn-neutral" title="如何贡献/修改文档" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../../_static/jquery.js"></script>
      <script type="text/javascript" src="../../_static/underscore.js"></script>
      <script type="text/javascript" src="../../_static/doctools.js"></script>
      <script type="text/javascript" src="../../_static/translations.js"></script>
      <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
       
  
    <script type="text/javascript" src="../../_static/js/theme.js"></script>
  
  
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/js/perfect-scrollbar.jquery.min.js"></script>
  <script src="../../_static/js/paddle_doc_init.js"></script> 

</body>
</html>