From d740620f404f4dc4978f7b63db5571cf6006a461 Mon Sep 17 00:00:00 2001 From: PhilipMay Date: Mon, 1 Jan 2024 19:20:29 +0100 Subject: [PATCH 1/4] add PR template --- .github/pull_request_template.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ae3f2a2 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Description + + + +## Pull request checklist + +- [ ] add tests +- documentation + - [ ] add docstrings + - [ ] if a module is new: add API reference file for Sphinx in `docs/source/api-reference` + - [ ] check API doc of Sphinx - build and show with `make sphinx && make open-sphinx` +- [ ] fix checks + - start locale checks with `make check` + - fix formatting with `make format` +- Python type info + - [ ] check and improve Python type info + - [ ] double check if return types are specified - inclusing `-> None` +- [ ] check TODO comments in code +- [ ] check FIXME comments in code +- [ ] check if the copyright header needs an update From 872a0a51c4e79a554dfd3d3d14690887b838c6dd Mon Sep 17 00:00:00 2001 From: PhilipMay Date: Mon, 1 Jan 2024 19:26:03 +0100 Subject: [PATCH 2/4] f --- .github/pull_request_template.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ae3f2a2..16914a0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,17 +4,17 @@ ## Pull request checklist -- [ ] add tests +- \[ \] add tests - documentation - - [ ] add docstrings - - [ ] if a module is new: add API reference file for Sphinx in `docs/source/api-reference` - - [ ] check API doc of Sphinx - build and show with `make sphinx && make open-sphinx` -- [ ] fix checks - - start locale checks with `make check` - - fix formatting with `make format` + - \[ \] add docstrings + - \[ \] if a module is new: add API reference file for Sphinx in `docs/source/api-reference` + - \[ \] check API doc of Sphinx - build and show with `make sphinx && make open-sphinx` +- \[ \] fix checks + - start locale checks with `make check` + - fix formatting with `make format` - Python type info - - [ ] check and improve Python type info - - [ ] double check if return types are specified - inclusing `-> None` -- [ ] check TODO comments in code -- [ ] check FIXME comments in code -- [ ] check if the copyright header needs an update + - \[ \] check and improve Python type info + - \[ \] double check if return types are specified - inclusing `-> None` +- \[ \] check TODO comments in code +- \[ \] check FIXME comments in code +- \[ \] check if the copyright header needs an update From 8053215ed810d5df51cc6e91284cb8cb2fe6a857 Mon Sep 17 00:00:00 2001 From: PhilipMay Date: Mon, 1 Jan 2024 19:28:47 +0100 Subject: [PATCH 3/4] f --- .github/pull_request_template.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 16914a0..4f57b19 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,16 +5,12 @@ ## Pull request checklist - \[ \] add tests -- documentation - - \[ \] add docstrings - - \[ \] if a module is new: add API reference file for Sphinx in `docs/source/api-reference` - - \[ \] check API doc of Sphinx - build and show with `make sphinx && make open-sphinx` -- \[ \] fix checks - - start locale checks with `make check` - - fix formatting with `make format` -- Python type info - - \[ \] check and improve Python type info - - \[ \] double check if return types are specified - inclusing `-> None` +- \[ \] add docstrings +- \[ \] if a module is new: add API reference file for Sphinx in `docs/source/api-reference` +- \[ \] check API doc of Sphinx - build and show with `make sphinx && make open-sphinx` +- \[ \] fix checks - locale checks with `make check` - fix formatting with `make format` +- \[ \] check and improve Python type info +- \[ \] double check if return types are specified - inclusing `-> None` - \[ \] check TODO comments in code - \[ \] check FIXME comments in code - \[ \] check if the copyright header needs an update From 384b6114184ea6b4fa6e7f9d0d21676bcb4baa48 Mon Sep 17 00:00:00 2001 From: PhilipMay Date: Mon, 1 Jan 2024 19:29:21 +0100 Subject: [PATCH 4/4] fake commit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 78619ae..8b984f5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Build & Deploy Doc](https://github.com/telekom/mltb2/actions/workflows/build_deploy_doc.yml/badge.svg)](https://github.com/telekom/mltb2/actions/workflows/build_deploy_doc.yml) [![GitHub issues](https://img.shields.io/github/issues-raw/telekom/mltb2)](https://github.com/telekom/mltb2/issues) -📦 A box of machine learning tools. 📦 +📦 A box of machine learning tools... 📦 - [Documentation Page](https://telekom.github.io/mltb2/) - [How to contribute](https://github.com/telekom/mltb2/blob/main/CONTRIBUTING.md)