diff --git a/.github/pull_request_templates/general.md b/.github/pull_request_templates/general.md new file mode 100644 index 0000000..7b6717d --- /dev/null +++ b/.github/pull_request_templates/general.md @@ -0,0 +1,6 @@ +### Description +[General purpose description] + +### Changes +[List of changes made on this PR] +- \ No newline at end of file diff --git a/.github/pull_request_templates/new_plot.md b/.github/pull_request_templates/new_plot.md new file mode 100644 index 0000000..7a2ff4f --- /dev/null +++ b/.github/pull_request_templates/new_plot.md @@ -0,0 +1,13 @@ +### Description +Adds new [PlotName] Plotly visualization + +### Tasks Checklist +- [ ] Create **Pydantic schema** in the `vuecore/schemas` folder. It should be aligned with the [plotly API](https://plotly.com/python-api-reference/index.html) +- [ ] Create a script with a **build function** in the `vuecore/engines/plotly` folder +- [ ] Update `theming.py` script in the `vuecore/engines/plotly` folder +- [ ] Register the new **builder** in the _`_init__.py` script of the `vuecore/engines/plotly` folder +- [ ] Create a script with the **user-facing function** in the `vuecore/plots` folder. It gathers the Pydantic schema, builder function, and saves the plot +- [ ] Create an **api example jupyter notebook** in the `docs/api_examples folder` +- [ ] Use **jupytext** to sync the Jupyter notebook with a Python script +- [ ] Update `index.md` file in the `docs` folder with the new example +- [ ] Create **test script** in the `/test` folder with the code from the example