Skip to content

Commit def8d81

Browse files
authored
Update contributing notes (plotly#2290)
* update * updated contributing notes * code pr in template * pinning orca * add doc requirement
1 parent 60e3666 commit def8d81

File tree

4 files changed

+485
-376
lines changed

4 files changed

+485
-376
lines changed

Diff for: .github/pull_request_template.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
<!--
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 :)
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+
If your PR modifies code of the `plotly` package, we have a different checklist
5+
below :-).
6+
7+
### Documentation PR
38
49
- [ ] I've [seen the `doc/README.md` file](https://github.com/plotly/plotly.py/blob/master/doc/README.md)
510
- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `master` branch
@@ -20,4 +25,12 @@ Please uncomment this block and take a look at this checklist if your PR is maki
2025
- [ ] `plotly.plot()` and `plotly.iplot()` are not used in any new/modified example
2126
- [ ] 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)
2227
28+
## Code PR
29+
30+
- [ ] I have read through the [contributing notes](https://github.com/plotly/plotly.py/blob/master/contributing.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the `codegen` files and not generated files.
31+
- [ ] I have added tests (if submitting a new feature or correcting a bug) or
32+
modified existing tests.
33+
- [ ] For a new feature, I have added documentation examples in an existing or
34+
new tutorial notebook (please see the doc checklist as well).
35+
2336
-->

Diff for: README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88
<img src="https://badge.fury.io/py/plotly.svg"/>
99
</td>
1010
</tr>
11+
<tr>
12+
<td>User forum</td>
13+
<td>
14+
<a href="https://community.plot.ly"/>
15+
<img src="https://img.shields.io/badge/help_forum-discourse-blue.svg"/>
16+
</td>
17+
</tr>
18+
1119
<tr>
1220
<td>PyPI Downloads</td>
1321
<td>
@@ -45,7 +53,7 @@ Read about what's new in [plotly.py v4](https://medium.com/plotly/plotly-py-4-0-
4553

4654
## Overview
4755

48-
[plotly.py](https://plot.ly/d3-js-for-python-and-pandas-charts/) is an interactive, open-source, and browser-based graphing library for Python :sparkles:
56+
[plotly.py](https://plot.ly/python) is an interactive, open-source, and browser-based graphing library for Python :sparkles:
4957

5058
Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is a high-level, declarative charting library. plotly.js ships with over 30 chart types, including scientific charts, 3D graphs, statistical charts, SVG maps, financial charts, and more.
5159

@@ -61,12 +69,12 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
6169
---
6270

6371
- [Online Documentation](https://plot.ly/python)
64-
- [Contributing](contributing.md)
72+
- [Contributing to plotly](contributing.md)
6573
- [Changelog](CHANGELOG.md)
6674
- [Code of Conduct](CODE_OF_CONDUCT.md)
6775
- [Version 4 Migration Guide](https://plot.ly/python/next/v4-migration/)
6876
- [New! Announcing Dash 1.0](https://medium.com/plotly/welcoming-dash-1-0-0-f3af4b84bae)
69-
- [Community](https://community.plot.ly/c/api/python)
77+
- [Community forum](https://community.plot.ly/c/api/python)
7078

7179
---
7280

0 commit comments

Comments
 (0)