You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We welcome contributions to the **leaflet** package!
2
+
3
+
To submit a contribution:
4
+
5
+
1.[Fork](https://github.com/rstudio/leaflet/fork) the repository and make your changes.
6
+
7
+
2. Ensure that you have signed the [individual](https://rstudioblog.files.wordpress.com/2017/05/rstudio_individual_contributor_agreement.pdf) or [corporate](https://rstudioblog.files.wordpress.com/2017/05/rstudio_corporate_contributor_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [email protected].
8
+
9
+
3. Submit a [pull request](https://help.github.com/articles/using-pull-requests).
10
+
11
+
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.
12
+
13
+
14
+
## How to make changes
15
+
16
+
Before you submit a pull request, please do the following:
17
+
18
+
* Add an entry to NEWS concisely describing what you changed.
19
+
20
+
* If appropriate, add unit tests in the tests/ directory.
21
+
22
+
* Run Build->Check Package in the RStudio IDE, or `devtools::check()`, to make sure your change did not add any messages, warnings, or errors.
23
+
24
+
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:
25
+
26
+
* breaking backward compatibility
27
+
* adding a feature that we do not consider relevant for leaflet
28
+
* is hard to understand
29
+
* is hard to maintain in the future
30
+
* is computationally expensive
31
+
* is not intuitive for people to use
32
+
33
+
We will try to be responsive and provide feedback in case we decide not to merge your pull request.
34
+
35
+
36
+
## Filing issues
37
+
38
+
If you find a bug in leaflet, you can also [file an issue](https://github.com/rstudio/leaflet/issues/new). Please provide as much relevant information as you can, and include a minimal reproducible example if possible.
Please briefly describe your problem and what output you expect. If you have a question, please try using stackoverflow <http://stackoverflow.com> first.
2
+
3
+
Please include a minimal reprex. The goal of a reprex is to make it as easy as possible for me to recreate your problem so that I can fix it. If you've never heard of a reprex before, start by reading <https://github.com/jennybc/reprex#what-is-a-reprex>, and follow the advice further down the page. Do NOT include session info unless it's explicitly asked for, or you've used `reprex::reprex(..., si = TRUE)` to hide it away.
4
+
5
+
Delete these instructions once you have read them.
Before you submit a pull request, please do the following:
4
+
5
+
* Add an entry to NEWS concisely describing what you changed.
6
+
7
+
* If appropriate, add unit tests in the tests/testthat directory.
8
+
9
+
* Run Build->Check Package in the RStudio IDE, or `devtools::check()`, to make sure your change did not add any messages, warnings, or errors.
10
+
11
+
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:
12
+
13
+
* breaking backward compatibility
14
+
* adding a feature that we do not consider relevant for leaflet
15
+
* is hard to understand
16
+
* is hard to maintain in the future
17
+
* is computationally expensive
18
+
* is not intuitive for people to use
19
+
20
+
We will try to be responsive and provide feedback in case we decide not to merge your pull request.
21
+
22
+
## Minimal reproducible example
23
+
24
+
Finally, please include a minimal reprex. The goal of a reprex is to make it as easy as possible for me to recreate your problem so that I can fix it. If you've never heard of a reprex before, start by reading <https://github.com/jennybc/reprex#what-is-a-reprex>, and follow the advice further down the page. Do NOT include session info unless it's explicitly asked for, or you've used `reprex::reprex(..., si = TRUE)` to hide it away.
25
+
26
+
Delete these instructions once you have read them.
27
+
28
+
---
29
+
30
+
Brief description of the solution
31
+
32
+
```r
33
+
# insert reprex here
34
+
```
35
+
36
+
PR task list:
37
+
-[ ] Update NEWS
38
+
-[ ] Add tests (if appropriate)
39
+
-[ ] Update documentation with `devtools::document()`
0 commit comments