-
Notifications
You must be signed in to change notification settings - Fork 0
auto-generated pkgdown website for: git2rdata
License
ropensci-docs/git2rdata
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html> <!-- Generated by pkgdown: do not edit by hand --><html lang="en-GB"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>CONTRIBUTING • git2rdata</title><!-- rOpenSci favicons --><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="/apple-touch-icon.png"><script src="deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="deps/headroom-0.11.0/headroom.min.js"></script><script src="deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="deps/search-1.0.0/fuse.min.js"></script><script src="deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="pkgdown.js"></script><link href="extra.css" rel="stylesheet"><meta property="og:title" content="CONTRIBUTING"><meta property="og:image" content="https://docs.ropensci.org/git2rdata/logo.svg"><link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v3.0.0/dist/cookieconsent.css"><script src="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v3.0.0/dist/cookieconsent.umd.js" data-cfasync="false"></script><script src="https://ropensci.org/scripts/matomo.js"></script><noscript><p><img src="https://ropensci.matomo.cloud/matomo.php?idsite=1&rec=1" style="border:0;" alt=""></p></noscript></head><body> <a href="#main" class="visually-hidden-focusable">Skip to contents</a> <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container"> <a href="https://ropensci.org" class="external-link"><img src="https://ropensci.org/img/icon_short_white.svg" id="hexlogo" alt="rOpenSci"></a> <a class="navbar-brand me-2" href="index.html">git2rdata</a> <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">0.5.0</small> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <div id="navbar" class="collapse navbar-collapse ms-3"> <ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="reference/index.html">Reference</a></li> <li class="nav-item"><a class="nav-link" href="news/index.html">Changelog</a></li> <li class="nav-item dropdown"> <button class="nav-link dropdown-toggle" type="button" id="dropdown-tutorials" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Tutorials</button> <ul class="dropdown-menu" aria-labelledby="dropdown-tutorials"><li><a class="dropdown-item" href="articles/plain_text.html">Getting started storing dataframes as plain text</a></li> <li><a class="dropdown-item" href="articles/version_control.html">Storing dataframes under version control</a></li> <li><a class="dropdown-item" href="articles/metadata.html">Metadata</a></li> <li><a class="dropdown-item" href="articles/workflow.html">Potential workflow</a></li> <li><a class="dropdown-item" href="articles/efficiency.html">Efficiency</a></li> <li><a class="dropdown-item" href="articles/split_by.html">Large dataframes</a></li> </ul></li> <li class="active nav-item"><a class="nav-link" href="CONTRIBUTING.html">Contributing</a></li> </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search"> <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="search.json"></form></li> <li class="nav-item"><a class="external-link nav-link" href="https://github.com/ropensci/git2rdata/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li> </ul></div> </div> </nav><div class="container template-title-body"> <div class="row"> <main id="main" class="col-md-9"><div class="page-header"> <img src="logo.svg" class="logo" alt=""><h1>CONTRIBUTING</h1> <small class="dont-index">Source: <a href="https://github.com/ropensci/git2rdata/blob/HEAD/.github/CONTRIBUTING.md" class="external-link"><code>.github/CONTRIBUTING.md</code></a></small> </div> <div id="contributing" class="section level1"> <div class="section level3"> <h3 id="fixing-typos">Fixing typos<a class="anchor" aria-label="anchor" href="#fixing-typos"></a></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. E.g. edit a <code>roxygen2</code> comment in a <code>.R</code> file below <code>R/</code>, not in an <code>.Rd</code> file below <code>man/</code>.</p> </div> <div class="section level3"> <h3 id="prerequisites">Prerequisites<a class="anchor" aria-label="anchor" href="#prerequisites"></a></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" class="external-link">reproducible example</a>.</p> </div> <div class="section level3"> <h3 id="pull-request-process">Pull request process<a class="anchor" aria-label="anchor" href="#pull-request-process"></a></h3> <ul><li>We recommend that you create a Git branch for each pull request (PR).<br></li> <li>Look at the GitHub Actions 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>We require the <code>tidyverse</code> <a href="http://style.tidyverse.org" class="external-link">style guide</a>. You can use the <a href="https://CRAN.R-project.org/package=styler" class="external-link"><code>styler</code></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" class="external-link"><code>roxygen2</code></a>.<br></li> <li>We use <a href="https://cran.r-project.org/package=testthat" class="external-link"><code>testthat</code></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 class="section level3"> <h3 id="code-of-conduct">Code of Conduct<a class="anchor" aria-label="anchor" href="#code-of-conduct"></a></h3> <p>Please note that this project is released with a <a href="CODE_OF_CONDUCT.html">Contributor Code of Conduct</a>. By contributing to this project you agree to abide by its terms.</p> </div> <div class="section level3"> <h3 id="prefer-to-email">Prefer to Email?<a class="anchor" aria-label="anchor" href="#prefer-to-email"></a></h3> <p>Email the person listed as maintainer in the <code>DESCRIPTION</code> file of this repo.</p> <p>Though note that private discussions over email don’t help others - of course email is totally warranted if it’s a sensitive problem of any kind.</p> </div> <div class="section level3"> <h3 id="thanks-for-contributing">Thanks for contributing!<a class="anchor" aria-label="anchor" href="#thanks-for-contributing"></a></h3> <p>This contributing guide is adapted from the <code>tidyverse</code> contributing guide available at <a href="https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md" class="external-link uri">https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md</a></p> </div> </div> </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2> </nav></aside></div> <footer><!-- begin footer --><div class="footer"> <div class="container"> <div class="row start top-4 bottom-8"> <div class="col-2"> <img id="footerlogo" src="https://ropensci.org/img/icon_short_white.svg"></div> <div class="col-10"> <div class="row"> <div class="col-md-4 col-xs-6"> <a href="https://github.com/ropensci" target="_blank" class="external-link"><div class="icon fab fa-github"></div></a> <a href="https://github.com/ropenscilabs" target="_blank" class="external-link"><div class="icon fa fa-flask"></div></a> <a href="https://hachyderm.io/@ropensci" target="_blank" class="external-link"><div class="icon fab fa-mastodon"></div></a> <a href="https://vimeo.com/ropensci" target="_blank" class="external-link"><div class="icon fab fa-vimeo"></div></a> </div> </div> <div class="row top-4"> <div class="col-md-2 col-sm-4"> <ul><h5 class="bottom-2">About</h5> <li><a href="https://ropensci.org/about" class="external-link">About rOpenSci</a></li> <li><a href="https://ropensci.org/software-review" class="external-link">Software Review</a></li> <li><a href="https://ropensci.org/about#team" class="external-link">Our Team</a></li> <li><a href="https://ropensci.org/careers" class="external-link">Jobs</a></li> <li><a href="https://ropensci.org/donate" class="external-link">Donate</a></li> <li><a href="https://ropensci.org/contact" class="external-link">Contact Us</a></li> </ul></div> <div class="col-md-3 col-sm-4"> <ul><h5 class="bottom-2">Community</h5> <li><a href="https://ropensci.org/community/" class="external-link">Our Community</a></li> <li><a href="https://ropensci.org/commcalls/" class="external-link">Community calls</a></li> <li><a href="https://ropensci.org/events/" class="external-link">Events</a></li> <li><a href="https://discuss.ropensci.org/" class="external-link">Join the Discussion</a></li> <li><a href="https://ropensci.org/code-of-conduct" class="external-link">Code of conduct</a></li> </ul></div> <div class="col-md-2 col-sm-4"> <ul><h5 class="bottom-2">Resources</h5> <li><a href="https://ropensci.org/packages/" class="external-link">Packages</a></li> <li><a href="https://ropensci.org/usecases/" class="external-link">Use Cases</a></li> <li><a href="https://ropensci.org/talks-papers/" class="external-link">Talks & Publications</a></li> <li><a href="https://docs.ropensci.org/" class="external-link">Documentation</a></li> <li><a href="https://ropensci.org/news/" class="external-link">Newsletter</a></li> <li><a href="https://ropensci.org/how-to-cite-ropensci/" class="external-link">Cite rOpenSci</a></li> </ul></div> <div class="col-md-4 col-xs-12"> <h5 class="bottom-2"></h5> <p>rOpenSci is a fiscally sponsored project of <a href="http://numfocus.org" class="external-link">NumFOCUS</a>.</p> </div> </div> </div> </div> </div> </div> <!-- / end footer --> </footer></div> </body></html>
![https://docs.ropensci.org/git2rdata/logo.svg"><link](https://docs.ropensci.org/git2rdata/logo.svg"><link){kind=link}
![https://ropensci.org/img/icon_short_white.svg"></div](https://ropensci.org/img/icon_short_white.svg"></div){kind=link}
About
auto-generated pkgdown website for: git2rdata
License
Contributing
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published