From 524926bc2f0f1b4b2354b4665238e48dd49ed682 Mon Sep 17 00:00:00 2001
From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
Date: Fri, 16 Aug 2024 14:30:42 +0200
Subject: [PATCH 1/2] feat: update the GitHub templates

- improve Issue templates
- add Pull Request template

Also improve the README file to better explain the contents of the repository.
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 31 +++++++++------
 .github/ISSUE_TEMPLATE/feature_request.md | 10 ++---
 .github/pull_request_template.md          | 46 +++++++++++++++++++++++
 README.md                                 |  6 +--
 4 files changed, 74 insertions(+), 19 deletions(-)
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 5d3171a..26b2658 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,32 +1,41 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: "[BUG]"
+title: "[BUG] "
 labels: bug
 assignees: ''
 
 ---
 
-**Describe the bug**
+### Describe the bug
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+
+### To Reproduce
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+
+### Expected behavior
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+### Screenshots
+If applicable, add screenshots or videos to help explain your problem.
+
+
+### Environment
+ - Desktop or mobile:
+ - OS and version: [e.g. iOS 14.1]
+ - Browser and version: [e.g. chrome 118, safari 15] 
+ - Node/npm version (if applicable):
+ - Used frameworks (if applicable):
+
+
 
-**Additional context**
+### Additional context
 Add any other context about the problem here.
+  
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index f3615ed..62ace54 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,20 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "[FEAT]"
+title: "[FEAT] "
 labels: enhancement
 assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+### Is your feature request related to a problem? Please describe.
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
+### Describe the solution you'd like
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+### Additional context
 Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..f037d21
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,46 @@
+<!--
+👋 Hi, thanks for sending a Pull Request to a repository of the `Process Analytics` project! 💖
+Please fill out all fields below and make sure each item is true and [x] checked.
+Otherwise we may not be able to review your PR.
+
+Note: core contributors are not required to use this template.
+-->
+
+## PR Checklist
+
+- [ ] Addresses an existing open issue: closes #<the_issue_number_here>.
+- [ ] You have discussed this issue with the maintainers of the repository, and you are assigned to the issue. 
+- [ ] If it exists, steps in the CONTRIBUTING guide (generally described in the `CONTRIBUTING.md` file at the root of the repository) were taken.
+- [ ] The PR title follows the ["Conventional Commits"](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
+
+<!--
+The PR title must look like `<type>[optional scope]: <lower case description>`
+
+*type* can be (see existing Pull Request for more elements):
+- chore
+- docs
+- feat
+- fix
+- refactor
+  ...
+
+If defined, the _optional scope_ must be put in parentheses.
+
+Note: The title is used as proposal for the maintainer merging the Pull Request.
+-->
+
+
+## Overview
+
+<!-- Description of what and why is changed, and how the code change does that. -->
+- Explain the **details** for making this change: What existing problem does the Pull Request solve? Why is this feature beneficial?
+- If your contribution has altered the BPMN rendering or any other visual feature, add screenshots.
+- If the Pull Request includes breaking changes, it must explicitly follow the syntax proposed by [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) (in the PR title and with a quote at this end of this overview).
+
+
+## Notes
+
+<!-- Use this paragraph to provide the reviewer with any additional information. -->
+
+N/A
+
diff --git a/README.md b/README.md
index 610e29f..11a0240 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,6 @@
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
 
-Default community health files for the process-analytics organization.
-
-For usage, the [GitHub documentation](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file).
+Shared resources for the `Process Analytics` organization.
+  - Default community health files (templates, ...). For usage, the [GitHub documentation](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file).
+  - Shared configuration (`release-drafter`, ...)

From 682564f8a869a6b016e361abb3600d850f5b51ea Mon Sep 17 00:00:00 2001
From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
Date: Fri, 16 Aug 2024 14:35:30 +0200
Subject: [PATCH 2/2] Improve README.md

---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 11a0240..52312b3 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
 
-Shared resources for the `Process Analytics` organization.
+This repository includes:
+- The source of the [profile](./profile) displayed in the [Process Analytics organization](https://github.com/process-analytics)
+- Shared resources for the `Process Analytics` organization.
   - Default community health files (templates, ...). For usage, the [GitHub documentation](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file).
   - Shared configuration (`release-drafter`, ...)
