feat: add badges and update PR template

Signed-off-by: develop-cs <[email protected]>

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,14 @@
-## Description
-A few sentences describing the overall goals of the pull request's commits.
+## What?
+Explain with one or more sentences what this change is doing.
 
-## Todos
-- [ ] Tests
-- [ ] Documentation
+## Have you done?
+- [ ] Code tests
+- [ ] Update documentation
+- [ ] Update [changelog](https://github.com/MAIF/arta/blob/main/CHANGELOG.md).
 
-## Steps to Test or Reproduce
-Outline the steps to test or reproduce the PR here.
+## Details to be checked (optional)
+If needed, add some details here in order to verify the change (e.g., how to test).
 
-1. First step
-2. ...
+## Linked issues (optional)
+- Close ...
+- Close ...

README.md

@@ -1,14 +1,15 @@
 # Arta
 
-![Python](https://img.shields.io/badge/Python-3.9_--_3.12-blue)
+![Alt CI](https://github.com/MAIF/arta/actions/workflows/ci-cd.yml/badge.svg?branch=main)
+![Alt Python](https://img.shields.io/badge/Python-3.9_--_3.12-blue)
 
-![Alt MAIF Logo](https://static.maif.fr/resources/img/logo-maif.svg)
+[![Alt MAIF Logo](https://static.maif.fr/resources/img/logo-maif.svg)](https://www.maif.fr/)
 
 **Arta** is a very simple python rules engine designed for and by python developers.
 
 ## Reference Documentation
 
-The reference documentation is available at [here](https://pages.github.com/MAIF/arta)
+The reference documentation is available [here](https://solid-eureka-93ze9kn.pages.github.io/).
 
 ## What's New
 

pyproject.toml

@@ -40,6 +40,12 @@ ruff = ["ruff"]
 [tool.setuptools]
 package-dir = {"" = "src"}
 
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]