Skip to content

Commit 4afeaf8

Browse files
committed
Add contributing guidelines
1 parent 4aa3ff6 commit 4afeaf8

File tree

2 files changed

+34
-10
lines changed

2 files changed

+34
-10
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to plotly.js
2+
3+
## Opening issues
4+
5+
Search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/ropensci/plotly/issues/new)
6+
7+
Bug reports __must__ have a [reproducible example](http://adv-r.had.co.nz/Reproducibility.html) and include the output of `devtools::session_info()` (instead of `sessionInfo()`).
8+
9+
GitHub issues are great for reporting bugs and requesting new features, but implementation questions are better suited for Stack Overflow (tagged
10+
[`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or on
11+
community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)).
12+
13+
## Development guidelines
14+
15+
If you'd like to contribute changes to plotly, we use [the GitHub flow](https://guides.github.com/introduction/flow/index.html) for proposing, submitting, reviewing, and accepting changes. If you haven't done this before, Hadley Wickham provides a nice overview of git (<http://r-pkgs.had.co.nz/git.html>), as well as best practices for submitting pull requests (<http://r-pkgs.had.co.nz/git.html#pr-make>). We also recommend using his style guide when writing code (<http://adv-r.had.co.nz/Style.html>).
16+
17+
If your pull request fixes a bug, or implements a new feature, it's a good idea to write a test (<http://r-pkgs.had.co.nz/tests.html>) to demonstrate it's working. If you'd like to closely simulate the tests that run when you submit your pull request, open R under your local plotly git repo, then do the following:
18+
19+
```r
20+
# the pull request number is arbitrary when running locally
21+
Sys.setenv('TRAVIS_PULL_REQUEST' = '1')
22+
Sys.setenv('TRAVIS_COMMIT' = substr(system('git rev-parse HEAD', intern = T), 1, 7))
23+
devtools::load_all(); source('tests/testthat.R', chdir = TRUE)
24+
```
25+
26+
## Code of Conduct
27+
28+
We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](https://github.com/ropensci/plotly/blob/master/CONDUCT.md) for more information.

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ devtools::install_github("ropensci/plotly")
2020

2121
## Introduction
2222

23-
If you use [ggplot2](http://cran.r-project.org/package=ggplot2), simply call `ggplotly()` to convert your ggplot to an interactive, web-based version!
23+
If you use [ggplot2](http://cran.r-project.org/package=ggplot2), use `ggplotly()` to convert your ggplot to an interactive, web-based version!
2424

2525
```r
2626
library(plotly)
@@ -50,19 +50,15 @@ The `ggplotly()` function converts a ggplot object to a plotly object, so if you
5050
layout(gg, hovermode = "closest")
5151
```
5252

53-
## Learn more
53+
## Documentation
5454

55-
* [An overview of plotly's R API](https://cdn.rawgit.com/ropensci/plotly/master/vignettes/intro.html)
56-
* Peruse the examples on plotly's [R homepage](https://plot.ly/r) and [ggplot2 homepage](https://plot.ly/ggplot2)
55+
* [An introduction to plotly's R API](https://cran.r-project.org/web/packages/plotly/vignettes/intro.html)
56+
* Examples and vignettes on plotly's R homepage - <https://plot.ly/r>
57+
* The complete figure reference guide - <https://plot.ly/r/reference>
5758

5859
## Contributing
5960

60-
- We love collaboration! See the [wiki](https://github.com/ropensci/plotly/wiki/Development-guidelines) and the [code of conduct](https://github.com/ropensci/plotly/blob/master/CONDUCT.md) for more information.
61-
62-
## Stay in touch
63-
64-
65-
- [@plotlygraphs](https://twitter.com/plotlygraphs)
61+
Please read through our [contributing guidelines](https://github.com/ropensci/plotly/blob/master/CONTRIBUTING.md). Included are directions for opening issues, asking questions, contributing changes to plotly, and our code of conduct.
6662

6763
---
6864

0 commit comments

Comments
 (0)