From 02da6dea629aadc6f9e2bc49fa10f12807096784 Mon Sep 17 00:00:00 2001
From: develop-cs <43383361+develop-cs@users.noreply.github.com>
Date: Wed, 3 Apr 2024 15:08:12 +0200
Subject: [PATCH] feat: add badges and update PR template

Signed-off-by: develop-cs <43383361+develop-cs@users.noreply.github.com>
---
 .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++---------
 README.md                        |  7 ++++---
 pyproject.toml                   |  6 ++++++
 3 files changed, 21 insertions(+), 12 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 96ea742..7c9f312 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.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 ...
\ No newline at end of file
diff --git a/README.md b/README.md
index 02af46d..3b4c110 100644
--- a/README.md
+++ b/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
 
diff --git a/pyproject.toml b/pyproject.toml
index 6c275ce..733e49b 100644
--- a/pyproject.toml
+++ b/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"]