Skip to content

forestgeo/fgeo

Repository files navigation

<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Contributing to fgeo • fgeo</title>


<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/united/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />


<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>

<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script>




<meta property="og:title" content="Contributing to fgeo" />




<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->



  </head>

  <body>
    <div class="container template-title-body">
      <header>
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="index.html">fgeo</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.4.9000</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="articles/siteonly/reference.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Tutorials
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="https://fgeocomm.shinyapps.io/basics-vis/">Visualization basics</a>
    </li>
    <li>
      <a href="https://fgeocomm.shinyapps.io/basics-programming/">Programming basics</a>
    </li>
    <li>
      <a href="https://fgeocomm.shinyapps.io/transform-tibbles/">Tibbles</a>
    </li>
    <li>
      <a href="https://fgeocomm.shinyapps.io/transform-isolating/">Isolating data with dplyr</a>
    </li>
    <li>
      <a href="https://bookdown.org/fgeocomm/eda/">Exploratory data analysis</a>
    </li>
  </ul>
</li>
      </ul>
      <ul class="nav navbar-nav navbar-right">
        <li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Community
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="articles/siteonly/fgeo-1-2-0-release-candidate.html">Release candidate 1.2.0</a>
    </li>
    <li>
      <a href="articles/siteonly/questions-and-answers.html">Q&amp;A</a>
    </li>
    <li>
      <a href="https://rstudio.cloud/project/43852">Try fgeo in rstudio.cloud</a>
    </li>
    <li>
      <a href="https://github.com/forestgeo/learn/issues">Resources</a>
    </li>
    <li>
      <a href="https://github.com/forestgeo/forum/issues">Discuss</a>
    </li>
    <li>
      <a href="https://fgeo.netlify.com/">Blog</a>
    </li>
  </ul>
</li>
<li>
  <a href="https://github.com/maurolepore">
    <span class="fa fa-gavel"></span>
     
  </a>
</li>
<li>
  <a href="https://github.com/forestgeo/fgeo">
    <span class="fa fa-github"></span>
     
  </a>
</li>
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header>

<div class="row">
  <div class="contents col-md-9">
    <div class="page-header">
      <h1>Contributing to fgeo</h1>
    </div>

<div id="contributing-to-fgeo" class="section level1">

<p>This outlines how to propose a change to <strong>fgeo</strong>. For more detailed info about contributing to this, and other <strong>fgeo</strong> packages (<a href="http://forestgeo.github.io/fgeo" class="uri">http://forestgeo.github.io/fgeo</a>), please see the <a href="https://rstd.io/tidy-contrib"><strong>development contributing guide of the tidyverse</strong></a> (wherever you read <strong>tidyverse</strong> think <strong>fgeo</strong>).</p>
<div id="fixing-typos" class="section level3">
<h3 class="hasAnchor">
<a href="#fixing-typos" class="anchor"></a>Fixing typos</h3>
<p>Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the <em>source</em> file.</p>
<ul>
<li>YES: you edit a roxygen comment in a <code>.R</code> file below <code>R/</code>.</li>
<li>NO: you edit an <code>.Rd</code> file below <code>man/</code>.</li>
</ul>
</div>
<div id="prerequisites" class="section level3">
<h3 class="hasAnchor">
<a href="#prerequisites" class="anchor"></a>Prerequisites</h3>
<p>Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal <a href="https://www.tidyverse.org/help/#reprex">reprex</a>.</p>
</div>
<div id="pull-request-process" class="section level3">
<h3 class="hasAnchor">
<a href="#pull-request-process" class="anchor"></a>Pull request process</h3>
<ul>
<li>We recommend that you create a Git branch for each pull request (PR).<br>
</li>
<li>Look at the Travis build status before and after making changes. The <code>README</code> should contain badges for any continuous integration services used by the package.<br>
</li>
<li>New code should follow the tidyverse <a href="http://style.tidyverse.org">style guide</a>. You can use the <a href="https://CRAN.R-project.org/package=styler">styler</a> package to apply these styles, but please don’t restyle code that has nothing to do with your PR.<br>
</li>
<li>We use <a href="https://cran.r-project.org/package=roxygen2">roxygen2</a>, with <a href="https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html">Markdown syntax</a>, for documentation.<br>
</li>
<li>We use <a href="https://cran.r-project.org/package=testthat">testthat</a>. Contributions with test cases included are easier to accept.<br>
</li>
<li>For user-facing changes, add a bullet to the top of <code>NEWS.md</code> below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).</li>
</ul>
</div>
<div id="code-of-conduct" class="section level3">
<h3 class="hasAnchor">
<a href="#code-of-conduct" class="anchor"></a>Code of Conduct</h3>
<p>Please note that this project is released with a <a href="CODE_OF_CONDUCT.html">Contributor Code of Conduct</a>. By participating in this project you agree to abide by its terms.</p>
</div>
<div id="see-tidyverse-development-contributing-guide-for-further-details-wherever-you-read-tidyverse-think-fgeo-" class="section level3">
<h3 class="hasAnchor">
<a href="#see-tidyverse-development-contributing-guide-for-further-details-wherever-you-read-tidyverse-think-fgeo-" class="anchor"></a>See tidyverse <a href="https://rstd.io/tidy-contrib">development contributing guide</a> for further details (wherever you read <strong>tidyverse</strong> think <strong>fgeo</strong>).</h3>
</div>
</div>

  </div>

</div>



      <footer>
      <div class="copyright">
  <p>Developed by <a href='https://forestgeo.si.edu/mauro-lepore'>Mauro Lepore</a>, <a href='https://forestgeo.si.edu/arellano-gabriel'>Gabriel Arellano</a>, Richard  Condit, <a href='https://forestgeo.si.edu/stuart-j-davies'>Stuart Davies</a>, Matteo Detto, <a href='https://sites.google.com/site/forestecoclimlab/people'>Erika Gonzalez-Akre</a>, Pamela Hall, Kyle Harms, <a href='https://valentineherr.github.io/'>Valentine Herrmann</a>, <a href='https://forestgeo.si.edu/david-kenfack'>David Kenfack</a>, <a href='https://forestgeo.si.edu/suzanne-lao'>Suzanne Lao</a>, <a href='https://forestgeo.si.edu/sean-mcmahon'>Sean McMahon</a>, <a href='http://russolab.unl.edu'>Sabrina Russo</a>, Kristina Anderson-Teixeira, Graham Zemunik, Daniel Zuleta, <a href='http://www.forestgeo.si.edu/'>CTFS-ForestGEO</a>.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p>
</div>

      </footer>
   </div>

  


  </body>
</html>