Skip to content

Commit 6ebff02

Browse files
Merge pull request plotly#2253 from plotly/doc_checklist
documentation PR checklist
2 parents 46cd47f + 4ec2cb3 commit 6ebff02

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/pull_request_template.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
Please uncomment this block and take a look at this checklist if your PR is making substantial changes to documentation/impacts files in the `doc` directory. Check all that apply to your PR, and leave the rest unchecked to discuss with your reviewer! Not all boxes must be checked for every PR :)
3+
4+
- [ ] I've [seen the `doc/README.md` file](https://github.com/plotly/plotly.py/blob/master/doc/README.md)
5+
- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `master` branch
6+
- [ ] If this PR modifies the first example in a page or adds a new one, it is a `px` example if at all possible
7+
- [ ] Every new/modified example has a descriptive title and motivating sentence or paragraph
8+
- [ ] Every new/modified example is independently runnable
9+
- [ ] 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
10+
- [ ] Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
11+
- [ ] The random seed is set if using randomly-generated data in new/modified examples
12+
- [ ] New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
13+
- [ ] Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
14+
- [ ] Imports are `plotly.graph_objects as go` / `plotly.express as px` / `plotly.io as pio`
15+
- [ ] Data frames are always called `df`
16+
- [ ] `fig = <something>` call is high up in each new/modified example (either `px.<something>` or `make_subplots` or `go.Figure`)
17+
- [ ] Liberal use is made of `fig.add_*` and `fig.update_*` rather than `go.Figure(data=..., layout=...)` in every new/modified example
18+
- [ ] Specific adders and updaters like `fig.add_shape` and `fig.update_xaxes` are used instead of big `fig.update_layout` calls in every new/modified example
19+
- [ ] `fig.show()` is at the end of each new/modified example
20+
- [ ] `plotly.plot()` and `plotly.iplot()` are not used in any new/modified example
21+
- [ ] Hex codes for colors are not used in any new/modified example in favour of [these nice ones](https://github.com/plotly/plotly.py/issues/2192)
22+
23+
-->

0 commit comments

Comments
 (0)