rstudio/leaflet
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><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 to {leaflet} • leaflet</title><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/Source_Sans_Pro-0.4.10/font.css" rel="stylesheet"><link href="deps/Source_Code_Pro-0.4.10/font.css" rel="stylesheet"><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><meta property="og:title" content="Contributing to {leaflet}"></head><body>
<a href="#container" class="visually-hidden-focusable">Skip to content</a>
<nav class="navbar navbar-expand-lg fixed-top bg-none" data-bs-theme="light" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="index.html">leaflet</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.2.3.9000</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="articles/leaflet.html">Get started</a></li>
<li class="nav-item"><a class="nav-link" href="reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="articles/widget.html">The Map Widget</a></li>
<li><a class="dropdown-item" href="articles/choropleths.html">Choropleths</a></li>
<li><a class="dropdown-item" href="articles/colors.html">Colors</a></li>
<li><hr class="dropdown-divider"></li>
<li><h6 class="dropdown-header" data-toc-skip>Customize</h6></li>
<li><a class="dropdown-item" href="articles/popups.html">Popups and Labels</a></li>
<li><a class="dropdown-item" href="articles/showhide.html">Show/Hide Layers</a></li>
<li><a class="dropdown-item" href="articles/markers.html">Add markers to leaflet</a></li>
<li><a class="dropdown-item" href="articles/legends.html">Legends</a></li>
<li><a class="dropdown-item" href="articles/shapes.html">Lines and Shapes</a></li>
<li><a class="dropdown-item" href="articles/basemaps.html">Using Basemaps</a></li>
<li><hr class="dropdown-divider"></li>
<li><h6 class="dropdown-header" data-toc-skip>Spatial data</h6></li>
<li><a class="dropdown-item" href="articles/json.html">Working with GeoJSON & TopoJSON</a></li>
<li><a class="dropdown-item" href="articles/raster.html">Raster Images</a></li>
<li><a class="dropdown-item" href="articles/projections.html">Working with projections in Leaflet</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="articles/index.html">More articles...</a></li>
</ul></li>
<li class="nav-item"><a class="nav-link" href="news/index.html">Changelog</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/rstudio/leaflet/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
</ul></div>
</div>
</nav><div class="container template-title-body" id="container">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<h1>Contributing to {leaflet}</h1>
<small class="dont-index">Source: <a href="https://github.com/rstudio/leaflet/blob/main/.github/CONTRIBUTING.md" class="external-link"><code>.github/CONTRIBUTING.md</code></a></small>
</div>
<div id="contributing-to-leaflet" class="section level1">
<p>We welcome contributions to the <a href="https://rstudio.github.io/leaflet/">leaflet</a> package!</p>
<p>To submit a contribution:</p>
<ol style="list-style-type: decimal"><li><p><a href="https://github.com/rstudio/leaflet/fork" class="external-link">Fork</a> the repository and make your changes.</p></li>
<li><p>Ensure that you have signed the <a href="https://www.rstudio.com/wp-content/uploads/2014/06/rstudioindividualcontributoragreement.pdf" class="external-link">individual</a> or <a href="https://www.rstudio.com/wp-content/uploads/2014/06/rstudiocorporatecontributoragreement.pdf" class="external-link">corporate</a> contributor agreement as appropriate. You can send the signed copy to <a href="mailto:[email protected]" class="email">[email protected]</a>.</p></li>
<li><p>Submit a <a href="https://help.github.com/articles/using-pull-requests" class="external-link">pull request</a>.</p></li>
</ol><p>We generally do not merge pull requests that update included web libraries (such as Bootstrap or jQuery) because it is difficult for us to verify that the update is done correctly; we prefer to update these libraries ourselves.</p>
<div class="section level2">
<h2 id="how-to-make-changes">How to make changes<a class="anchor" aria-label="anchor" href="#how-to-make-changes"></a></h2>
<p>Before you submit a pull request, please do the following:</p>
<ul><li><p>Add an entry to NEWS concisely describing what you changed.</p></li>
<li><p>If appropriate, add unit tests in the tests/ directory.</p></li>
<li><p>Run Build->Check Package in the RStudio IDE, or <code>devtools::check()</code>, to make sure your change did not add any messages, warnings, or errors.</p></li>
</ul><p>Doing these things will make it easier for the leaflet development team to evaluate your pull request. Even so, we may still decide to modify your code or even not merge it at all. Factors that may prevent us from merging the pull request include:</p>
<ul><li>breaking backward compatibility</li>
<li>adding a feature that we do not consider relevant for leaflet</li>
<li>is hard to understand</li>
<li>is hard to maintain in the future</li>
<li>is computationally expensive</li>
<li>is not intuitive for people to use</li>
</ul><p>We will try to be responsive and provide feedback in case we decide not to merge your pull request.</p>
</div>
<div class="section level2">
<h2 id="filing-issues">Filing issues<a class="anchor" aria-label="anchor" href="#filing-issues"></a></h2>
<p>If you find a bug in leaflet, you can also <a href="https://github.com/rstudio/leaflet/issues/new" class="external-link">file an issue</a>. Please provide as much relevant information as you can, and include a minimal reproducible example if possible.</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>
</div>
<footer><div class="container">
<div class="pkgdown-footer-left">
<p>Developed by Joe Cheng, <a href="http://schloerke.com" class="external-link">Barret Schloerke</a>, Bhaskar Karambelkar, <a href="https://yihui.org/" class="external-link">Yihui Xie</a>, <a href="https://garrickadenbuie.com" class="external-link">Garrick Aden-Buie</a>, <a href="https://www.posit.co" class="external-link"><img src="https://www.tidyverse.org/posit-logo.svg" alt="Posit" height="16" width="62" style="margin-bottom: 3px;"></a>. The Leaflet JavaScript library is © 2010–2023 <a href="http://agafonkin.com/en" class="external-link">Vladimir Agafonkin</a>, 2010–2011 <a href="http://cloudmade.com/" class="external-link">CloudMade</a>. Maps © <a href="https://openstreetmap.org/copyright" class="external-link">OpenStreetMap</a> contributors unless otherwise noted.</p>
</div>
<div class="pkgdown-footer-right">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
</div>
</div></footer></body></html>
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
