From 43d436c3e5ac0baf0e91b42d74c22a3f37f099d4 Mon Sep 17 00:00:00 2001
From: Kevin Franklin Kim <kevin.kim@bestbytes.com>
Date: Thu, 27 Feb 2025 14:59:39 +0100
Subject: [PATCH] docs: add CONTRIBUTING.md

---
 .github/CONTRIBUTING.md               | 21 +++++++++++++++++++++
 .github/ISSUE_TEMPLATE/bug-report.md  | 17 +++++++++++++++++
 .github/ISSUE_TEMPLATE/enhancement.md |  8 ++++++++
 README.md                             |  2 +-
 4 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md
 create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..65bdbe0
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# Contributing
+
+If you want to submit a pull request to fix a bug or enhance an existing
+feature, please first open an issue and link to that issue when you
+submit your pull request.
+
+If you have any questions about a possible submission, feel free to open
+an issue too.
+
+### Pull request process
+
+1. Fork this repository
+2. Create a branch in your fork to implement the changes. We recommend using
+   the issue number as part of your branch name, e.g. `1234-fixes`
+3. Ensure that any documentation is updated with the changes that are required
+   by your fix.
+4. Ensure that any samples are updated if the base image has been changed.
+5. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
+   what your changes are meant to do and provide simple steps on how to validate
+   your changes. Ensure that you reference the issue you created as well.
+   The pull request will be review before it is merged.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 0000000..e415a86
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,17 @@
+---
+name: Bug Report
+about: Report a bug you encountered
+labels: bug
+---
+**What happened**:
+
+**What you expected to happen**:
+
+**How to reproduce it (as minimally and precisely as possible)**:
+
+**Anything else we need to know?**:
+
+**Environment**:
+- Affected Version:
+- OS (e.g: `cat /etc/os-release`):
+- Others:
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
new file mode 100644
index 0000000..bfa7836
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,8 @@
+---
+name: Enhancement Request
+about: Suggest an enhancement
+labels: enhancement
+---
+**What would you like to be added**:
+
+**Why is this needed**:
diff --git a/README.md b/README.md
index cdc916b..b53bfb1 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
 
 ## How to Contribute
 
-Make a pull request...
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
 ## License