diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..4f57b19 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +## Description + + + +## Pull request checklist + +- \[ \] add tests +- \[ \] 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 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)