From b3ef2d3c998d59cdf7335630a536312b75469cf5 Mon Sep 17 00:00:00 2001
From: "florentin.luce" <florentin@autourdeminuit.com>
Date: Fri, 21 Jul 2023 11:29:07 +0200
Subject: [PATCH] Update from template

---
 ISSUE_TEMPLATE.yml       | 51 ++++++++++++++++++++++++++++++++++++++++
 PULL_REQUEST_TEMPLATE.md | 16 +++++++++++++
 README.md                | 44 ++++++++++++++++++++++++++++++++++
 3 files changed, 111 insertions(+)
 create mode 100644 ISSUE_TEMPLATE.yml
 create mode 100644 PULL_REQUEST_TEMPLATE.md

diff --git a/ISSUE_TEMPLATE.yml b/ISSUE_TEMPLATE.yml
new file mode 100644
index 0000000..f603953
--- /dev/null
+++ b/ISSUE_TEMPLATE.yml
@@ -0,0 +1,51 @@
+name: Bug Report
+
+about: File a bug report
+
+title: "[Bug]: "
+
+body:
+  - id : ticket_type
+    type: dropdown
+    attributes:
+      label: Type
+      description: Type du ticket
+      options:
+        - bug
+        - feature
+        - maintenance
+        - documentation
+      validation:
+        required: true
+
+  - id : priority
+    type: dropdown
+    attributes:
+      label: Priorité
+      description: priorité du ticket
+      options:
+        - normal
+        - faible
+        - élevée
+        - critique
+  
+  - id: description
+    type: textarea
+    attributes:
+      label: Description
+      description: Description du problème rencontré
+      value: "ça marche pô... \nN'oubliez pas de préciser la task, l'asset ou le shot, et sa version dans le cas d'un bug"
+    validations:
+      required: true
+
+  - id: path
+    type: input
+    attributes:
+      label: filepath
+      description: le chemin de la scene s'il existe
+
+  - id: log
+    type: textarea
+    attributes:
+      label: Log console
+      description: Rensigner le crash log s'il existe
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..61d7160
--- /dev/null
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,16 @@
+## Related ticket
+Link to the ticket
+
+## Modications
+Description of what your PR is doing
+
+## How to test it
+Description of how to test it
+
+## Risk involved
+- LOW
+- MID
+- HIGH
+
+## Related PR
+List of PR involved with this one
diff --git a/README.md b/README.md
index e806a4f..cd329b2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
+# BONE_WIDGET
+> Blender addon to create bone controllers
+
+Bone_widget is a home blender plugin helping riggers to create their own bone controllers 
 
 explanation : https://vimeo.com/184159913
+
+
+<!-- TABLE OF CONTENTS -->
+***
+<summary>Table of Contents</summary>
+<ol>
+<li>
+    <a href="#installation">Installation</a>
+</li>
+<li>
+    <a href="#contents">Contents</a>
+</li>
+<li>
+    <a href="#location">Location</a>
+</li>
+</ol>
+
+
+<!-- INSTALLATION -->
+***
+## Installation
+
+1. Create your own local directory in 
+    ```sh
+   /home/<USER>/dev
+   ```
+2. Create your own local directory in 
+    ```sh
+   git clone ssh://git@192.168.75.224:222/autour_de_minuit/bone_widget.git
+   ```
+
+<!-- CONTENTS -->
+***
+## Contents
+
+<!-- LOCATION -->
+***
+## Location
+
+In the RIG TOOLS tab