diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 288a71d2de9..c432eaac7ad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,7 +27,7 @@ below :-). ## Code PR -- [ ] 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. +- [ ] 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. - [ ] I have added tests (if submitting a new feature or correcting a bug) or modified existing tests. - [ ] For a new feature, I have added documentation examples in an existing or diff --git a/CHANGELOG.md b/CHANGELOG.md index 30def8488f5..6ce45805309 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -716,7 +716,7 @@ This version includes several performance improvements ([#2368](https://github.c - Introduce range breaks on date axes (for example, to remove week-ends) via `layout.xaxis.rangebreaks` - Introduce a new unified x (or y) hovermode (`layout.hovermode="x unified"`), in which the hover box shows the information for all traces at a given x (or y) position - Add `node.customdata` and `link.customdata` to sankey traces -- Updated [contributing notes](https://github.com/plotly/plotly.py/blob/master/contributing.md) for more explanations on how to contribute to plotly.py [#2290](https://github.com/plotly/plotly.py/pull/2290). Please give feedback on these notes! +- Updated [contributing notes](https://github.com/plotly/plotly.py/blob/master/CONTRIBUTING.md) for more explanations on how to contribute to plotly.py [#2290](https://github.com/plotly/plotly.py/pull/2290). Please give feedback on these notes! - Updated documentation examples [#2325](https://github.com/plotly/plotly.py/pull/2325), and to show how to color links in Sankey diagrams [#2291](https://github.com/plotly/plotly.py/pull/2291). - Special thanks to [@SylwiaOliwia2](https://github.com/SylwiaOliwia2) and [@dangercrow](https://github.com/dangercrow) for improving our documentation! @@ -1738,7 +1738,7 @@ This is a major version with many exciting updates. See the [Introducing plotly. - Error message for `plotly.figure_factory.create_choropleth` is now helpful to Anaconda users who do not have the correct modules installed for the County Choropleth figure factory. ### Changed / Deprecated -Please see the [migration guid](migration-guide.md) for a full list of the changes and deprecations in version 3.0.0 +Please see the [migration guide](MIGRATION_GUIDE.md) for a full list of the changes and deprecations in version 3.0.0 diff --git a/contributing.md b/CONTRIBUTING.md similarity index 100% rename from contributing.md rename to CONTRIBUTING.md diff --git a/migration-guide.md b/MIGRATION_GUIDE.md similarity index 100% rename from migration-guide.md rename to MIGRATION_GUIDE.md diff --git a/README.md b/README.md index 0ffe11e7e33..d1e62f2e4a3 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is --- - [Online Documentation](https://plotly.com/python/) -- [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/contributing.md) +- [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/CONTRIBUTING.md) - [Changelog](https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md) - [Code of Conduct](https://github.com/plotly/plotly.py/blob/master/CODE_OF_CONDUCT.md) - [Community forum](https://community.plotly.com) diff --git a/release.md b/RELEASE.md similarity index 100% rename from release.md rename to RELEASE.md diff --git a/doc/README.md b/doc/README.md index 6362a8de3b1..938fc5712df 100644 --- a/doc/README.md +++ b/doc/README.md @@ -25,10 +25,10 @@ where you can edit the page on Github). For more important edits where you need to run the notebook to check the output, clone the repository and setup an environment as described in the [main -contributing notes](../contributing.md). If you're writing documentation at the +contributing notes](../CONTRIBUTING.md). If you're writing documentation at the same time as you are developing a feature, make sure to install with editable install (`pip install -e`, as described in [main -contributing notes](../contributing.md)), so that you only need to restart +contributing notes](../CONTRIBUTING.md)), so that you only need to restart the Jupyter kernel when you have changed the source code of the feature. ### Branches diff --git a/plotly/figure_factory/README.md b/plotly/figure_factory/README.md index edd7d0d05a1..435fedb2fb6 100644 --- a/plotly/figure_factory/README.md +++ b/plotly/figure_factory/README.md @@ -161,7 +161,7 @@ $ git push origin add-ff-type ## Be Part of the Discussion -Go check out your newly pushed branch at https://github.com/plotly/plotly.py. If you have any other questions, check out the [Plotly Contributing Page](https://github.com/plotly/plotly.py/blob/master/contributing.md). Thanks for contributing to Plotly's Graphing Library! +Go check out your newly pushed branch at https://github.com/plotly/plotly.py. If you have any other questions, check out the [Plotly Contributing Page](https://github.com/plotly/plotly.py/blob/master/CONTRIBUTING.md). Thanks for contributing to Plotly's Graphing Library! ### Table of Current Figure Factories | Name | Documentation | In GitHub |