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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+43-1
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,46 @@
1
-
# Contributing to plotly.js
1
+
# Contributing to Plotly.js
2
+
3
+
Thanks for your interest in contributing to Plotly.js! We are actively looking for
4
+
diverse contributors, with diverse background and skills.
5
+
6
+
This document outlines the general way that changes get made to this library and by whom,
7
+
and then provides specific technical information about how to set up a development
8
+
environment for doing development and running tests.
9
+
10
+
## Code of Conduct
11
+
12
+
Please check out our [Code of Conduct](code_of_conduct.md). Don't tl:dr; it
13
+
but the general idea is to be nice.
14
+
15
+
## Plotly.js vs Plotly.py and Plotly.R
16
+
17
+
[Plotly.js](https://plotly.com/javascript) is a standalone Javascript data visualization library, and it also powers the Python and R modules named `plotly` in those respective ecosystems (referred to as [Plotly.py](https://plotly.com/python) and [Plotly.R](http://plotly.com/r), respectively, for clarity). There also exist Plotly.js-powered libraries for other languages such as Julia, Scala, Rust, .NET and even C++!
18
+
19
+
The basic architecture of Plotly.js is to accept [JSON](https://json.org/) representation of figures that adhere to the [figure schema](https://plotly.com/javascript/reference/index/) and draw interactive graphical representations of these figures in a browser. Libraries in other languages like Python and R provide idiomatic interfaces for users of those languages to create and manipulate these JSON structures, and arrange for them to be rendered in a browser context by Plotly.js. This means that in many cases, when a Python or R user wishes to add a feature to the library they know as `plotly`, the relevant changes must be implemented in Plotly.js, in this repo.
20
+
21
+
## How do changes get made to Plotly.js?
22
+
23
+
A **new feature** is composed of additions to the schema - adding new attributes, adding entire new trace types, or just adding new values to existing attributes - along with the associated drawing code. This project has a strong commitment to backwards-compatibility, so changing the graphical output for existing schema attributes and values, or changing the default value of an attribute, is generally only done as a mostly-backwards-compatible **bug fix**, for cases when the current graphical output is incorrect, nonsensical or otherwise very problematic. Non-schema-related features and bug fixes are possible as well, usually around performance, security, bundling, function signatures etc, and generally follow the same principles.
24
+
25
+
The basic process for adding new features or fixing bugs is as follows. Please note that this is a bit of an idealized outline and that things often don't proceed in a clean/linear fashion and that's ok :)
26
+
27
+
1.**Discussion** - A community member or maintainer creates an issue to discuss the use-case for the new feature. This usually entails describing the desired graphical output and discussing how close the current system can get to specifying or drawing such a figure. If the issue is perceived to be a bug, the discussion revolves around understanding how the current behaviour is incorrect or problematic, and how existing users of the system would be impacted by a change in this behaviour.
28
+
2.**Proposal** - If the current system cannot specify or draw such a figure, or if the way to do it is too onerous, a good next step would be to discuss or propose a specific change to the schema: new attributes to be added or new accepted values to new attributes, along with a prose description of the proposed drawing code. If the issue is determined to be a bug rather than a feature, the same type of proposal is required: a definition of which attributes and values will be impacted by the proposed change. A good proposal includes discussion of whether or not existing attributes can be modified rather than adding new attributes and details about which trace types or subplot types are impacted by the change. Note: sometimes community contributors skip this step and go straight to development & review (below), but going through a proposal can help speed along the review process!
29
+
3.**Iteration** - The maintainers of the library or any other interested community member will then give feedback on the proposal, usually focused on consistency with the rest of the schema, and helping define a test plan to further elaborate potential edge cases.
30
+
4.**Approval** - After a number of iterations, the maintainers of the library will generally approve a proposal with an informal "this seems like something we would accept a pull request for" comment in the issue.
31
+
5.**Development** - A community member or maintainer creates a branch and makes the appropriate modifications to the code and tests and opens a pull request. This can be more or less time-consuming and challenging, depending on the nature of the change.
32
+
6.**Review** - The maintainers of the library will review the pull request, working with the original authors to ensure the code is ready for merging. This can involve quite a few iterations and exploration of edge cases, additions of tests etc, but the maintainers are very happy to have outside contributors and will try to make this as painless as possible. Starting out with a previously-discussed proposal (see above) generally helps make this smoother as it reduces the likelihood of overlooked requirements that would prevent a merge.
33
+
7.**Long-term Maintenance** - Once the code is merged, the maintainers of the library will generally look after its maintenance, performance, security, bug fixes etc, although the original author of a feature is always welcome and encouraged to participate in this process!
34
+
35
+
### The Plotly.js Maintainers
36
+
37
+
The current Plotly.js maintainers are all employees of Plotly (the company) and one of their primary responsibilities is ensuring the process above runs smoothly. It is worth noting that maintainers and non-maintainer Plotly employees all follow the process above: proposing changes, iterating on proposals and eventually developing and reviewing each other's pull requests. As mentioned above, maintainers look after bug fixes, performance, security, documentation and concerns that impact the long-term prospects for this library. In terms of development work, maintainers tend to prioritize issues that do or are likely to impact Plotly customers, as well as on [sponsored features or bug fixes](https://plot.ly/products/consulting-and-oem/). Sponsored work proceeds via the process listed above, albeit with the option of conducting portions of the "discussion" step in a confidential setting if desired. Please note that maintainers are happy and eager to help with community-led pull requests, independent of customer-driven development priorities :)
38
+
39
+
### The Plotly.js Community
40
+
The Plotly.js community, construed fairly broadly, includes the maintainers and all users of Plotly.js and associated projects ([Plotly.py](https://plotly.com/python), [Dash](https://dash.plotly.com/), [Plotly.R](https://plotly.com/r), [Chart Studio](https://plotly.com/chart-studio) and many others). The community includes people from any background, domain, affiliation and level of technical expertise, for example (but not limited to!) employees of small or large companies or startups; employees or students of universities or other educational institutions; government employees and contractors; employees and volunteers of non-profits; individual hobbyists etc.
41
+
42
+
**Anyone in the community is encouraged to contribute to every step of the process described above!** Creating issues to report bugs or suggest new behaviours is a valuable contribution to this project, as is proposing a concrete set of changes to address issues created by anyone at any time. In the same way, giving feedback on proposals created by anyone in the community is valuable, as is, of course, development and review work. [Proposing changes to the documentation of Plotly.js or associated projects](https://github.com/plotly/graphing-library-docs/blob/master/README.md) is an extremely valuable form of contribution, as is [asking or answering questions on our community forum](https://community.plotly.com/), as it creates a record of a question and discussion, which others can stumble across later and use to further their own work.
Built on top of [d3.js](https://d3js.org/) and [stack.gl](http://stack.gl/),
8
-
plotly.js is a high-level, declarative charting library. plotly.js ships with over 40
9
-
chart types, including scientific charts, 3D graphs, statistical charts, SVG maps, financial charts,
10
-
and more.
7
+
[Plotly.js](https://plotly.com/javascript) is a standalone Javascript data visualization library, and it also powers the Python and R modules named `plotly` in those respective ecosystems (referred to as [Plotly.py](https://plotly.com/python) and [Plotly.R](http://plotly.com/r)).
8
+
9
+
Plotly.js can be used to produce dozens of chart types and visualizations, including statistical charts, 3D graphs, scientific charts, SVG and tile maps, financial charts and more.
@@ -112,14 +111,14 @@ Building instructions using `webpack`, `browserify` and other build frameworks a
112
111
113
112
## Bugs and feature requests
114
113
115
-
Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#opening-issues).
114
+
Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/masterCONTRIBUTING.md)
116
115
117
116
## Documentation
118
117
119
-
Official plotly.js documentation is hosted on [plotly.com/javascript](https://plotly.com/javascript).
118
+
Official plotly.js documentation is hosted at [https://plotly.com/javascript](https://plotly.com/javascript).
120
119
121
120
These pages are generated by the Plotly [graphing-library-docs repo](https://github.com/plotly/graphing-library-docs) built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages.
122
-
For more info about contributing to Plotly documentation, please read through [contributing guidelines](https://github.com/plotly/documentation/blob/source/Contributing.md).
121
+
For more info about contributing to Plotly documentation, please read through [contributing guidelines](https://github.com/plotly/graphing-library-docs/blob/master/README.md).
123
122
124
123
## Contributing
125
124
@@ -128,7 +127,6 @@ Please read through our [contributing guidelines](https://github.com/plotly/plot
128
127
## Community
129
128
130
129
* Follow [@plotlygraphs](https://twitter.com/plotlygraphs) on Twitter for the latest Plotly news.
131
-
* Follow [@plotly_js](https://twitter.com/plotly_js) on Twitter for plotly.js release updates.
132
130
* Implementation help may be found on community.plot.com (tagged [`plotly-js`](https://community.plotly.com/c/plotly-js)) or
133
131
on Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
134
132
* Developers should use the keyword `plotly` on packages which modify or add to the functionality of plotly.js when distributing through [npm](https://www.npmjs.com/browse/keyword/plotly).
@@ -139,48 +137,32 @@ This project is maintained under the [Semantic Versioning guidelines](https://se
139
137
140
138
See the [Releases section](https://github.com/plotly/plotly.js/releases) of our GitHub project for changelogs for each release version of plotly.js.
141
139
142
-
## Clients for R, Python, Node, and MATLAB
143
-
144
-
Open-source clients to the plotly.js APIs are available at these links:
Plotly.js is at the core of a large and dynamic ecosystem with many contributors who file issues, reproduce bugs, suggest improvements, write code in this repo (and other upstream or downstream ones) and help users in the Plotly community forum. The following people deserve special recognition for their outsized contributions to this ecosystem:
143
+
144
+
|| GitHub | Twitter | Status |
145
+
|---|--------|---------|--------|
146
+
|**Alex C. Johnson**|[@alexcjohnson](https://github.com/alexcjohnson)|| Active, Maintainer |
|**Nicolas Kruchten**|[@nicolaskruchten](https://github.com/nicolaskruchten)|[@nicolaskruchten](https://twitter.com/nicolaskruchten)| Active |
150
+
|**Jon Mease**|[@jonmmease](https://github.com/jonmmease)|[@jonmmease](https://twitter.com/jonmmease)| Active |
151
+
|**Étienne Tétreault-Pinard**|[@etpinard](https://github.com/etpinard)|[@etpinard](https://twitter.com/etpinard)| Hall of Fame |
152
+
|**Mikola Lysenko**|[@mikolalysenko](https://github.com/mikolalysenko)|[@MikolaLysenko](https://twitter.com/MikolaLysenko)| Hall of Fame |
153
+
|**Ricky Reusser**|[@rreusser](https://github.com/rreusser)|[@rickyreusser](https://twitter.com/rickyreusser)| Hall of Fame |
154
+
|**Dmitry Yv.**|[@dy](https://github.com/dy)|[@DimaYv](https://twitter.com/dimayv)| Hall of Fame |
155
+
|**Robert Monfera**|[@monfera](https://github.com/monfera)|[@monfera](https://twitter.com/monfera)| Hall of Fame |
156
+
|**Robert Möstl**|[@rmoestl](https://github.com/rmoestl)|[@rmoestl](https://twitter.com/rmoestl)| Hall of Fame |
157
+
|**Nicolas Riesco**|[@n-riesco](https://github.com/n-riesco)|| Hall of Fame |
158
+
|**Miklós Tusz**|[@mdtusz](https://github.com/mdtusz)|[@mdtusz](https://twitter.com/mdtusz)| Hall of Fame |
159
+
|**Chelsea Douglas**|[@cldougl](https://github.com/cldougl)|| Hall of Fame |
160
+
|**Ben Postlethwaite**|[@bpostlethwaite](https://github.com/bpostlethwaite)|| Hall of Fame |
161
+
|**Chris Parmer**|[@chriddyp](https://github.com/chriddyp)|| Hall of Fame |
162
+
|**Alex Vados**|[@alexander-daniel](https://github.com/alexander-daniel)|| Hall of Fame |
179
163
180
164
## Copyright and license
181
165
182
166
Code and documentation copyright 2020 Plotly, Inc.
183
167
184
168
Code released under the [MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE).
185
-
186
-
Docs released under the [Creative Commons license](https://github.com/plotly/documentation/blob/source/LICENSE).
0 commit comments