|
1 | 1 | <!-- |
2 | | -Please uncomment this block and fill in this checklist if your PR makes substantial changes to documentation in the `doc` directory. |
3 | | -Not all boxes must be checked for every PR: |
4 | | -check those that apply to your PR and leave the rest unchecked to discuss with your reviewer. |
5 | | -
|
6 | | -If your PR modifies code of the `plotly` package, we have a different checklist below. |
7 | | -
|
8 | | -## Documentation PR |
9 | | -
|
10 | | -- [ ] I have seen the [`doc/README.md`](https://github.com/plotly/plotly.py/blob/main/doc/README.md) file. |
11 | | -- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `main` branch. |
12 | | -- [ ] If this PR modifies the first example in a page or adds a new one, it is a `px` example if at all possible. |
13 | | -- [ ] Every new/modified example has a descriptive title and motivating sentence or paragraph. |
14 | | -- [ ] Every new/modified example is independently runnable. |
15 | | -- [ ] Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized. |
16 | | -- [ ] Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible. |
17 | | -- [ ] The random seed is set if using randomly-generated data. |
18 | | -- [ ] New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets. |
19 | | -- [ ] Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations. |
20 | | -- [ ] Imports are `plotly.graph_objects as go`, `plotly.express as px`, and/or `plotly.io as pio`. |
21 | | -- [ ] Data frames are always called `df`. |
22 | | -- [ ] `fig = <something>` is called high up in each new/modified example (either `px.<something>` or `make_subplots` or `go.Figure`). |
23 | | -- [ ] Liberal use is made of `fig.add_*` and `fig.update_*` rather than `go.Figure(data=..., layout=...)`. |
24 | | -- [ ] Specific adders and updaters like `fig.add_shape` and `fig.update_xaxes` are used instead of big `fig.update_layout` calls. |
25 | | -- [ ] `fig.show()` is at the end of each example. |
26 | | -- [ ] `plotly.plot()` and `plotly.iplot()` are not used in any example. |
27 | | -- [ ] Named colors are used instead of hex codes wherever possible. |
28 | | -- [ ] Code blocks are marked with ````python`. |
29 | | -
|
30 | | -## Code PR |
31 | | -
|
32 | | -- [ ] I have read through the [contributing notes](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the code generator and *not* the generated files. |
33 | | -- [ ] I have added tests or modified existing tests. |
34 | | -- [ ] For a new feature, I have added documentation examples (please see the doc checklist as well). |
35 | | -- [ ] I have added a CHANGELOG entry if changing anything substantial. |
36 | | -- [ ] For a new feature or a change in behavior, I have updated the relevant docstrings in the code. |
| 2 | +Thank you for your contribution to plotly.py! |
37 | 3 |
|
| 4 | +Please complete each section below. |
38 | 5 | --> |
| 6 | + |
| 7 | +## Link to issue |
| 8 | + |
| 9 | +Closes (#) |
| 10 | + |
| 11 | +## Description of change |
| 12 | + |
| 13 | +(1-2 sentences) |
| 14 | + |
| 15 | +## Demo |
| 16 | + |
| 17 | +(Include screenshot or screen recording) |
| 18 | + |
| 19 | +## Testing strategy |
| 20 | + |
| 21 | +(1-2 sentences explaining tests added or changed, or why testing changes are not needed) |
0 commit comments