From 719d611243b00e60c9c5b97a116d61b34515c6a1 Mon Sep 17 00:00:00 2001 From: sayalaruano Date: Wed, 13 Aug 2025 10:43:44 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=91=E2=80=8D=F0=9F=92=BB=20Dev:=20add?= =?UTF-8?q?=20PR=20templates=20for=20general=20contributions=20and=20add?= =?UTF-8?q?=20new=20plots?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/pull_request_templates/general.md | 6 ++++++ .github/pull_request_templates/new_plot.md | 13 +++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 .github/pull_request_templates/general.md create mode 100644 .github/pull_request_templates/new_plot.md 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