Feature/adding markdown files

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+## What changed?
+
+## Issue ticket(s) number and link
+
+## Checklist before requesting a review
+- [ ] I have performed a self-review of my code
+- [ ] If it is a feature, my code has unit/integration tests and pass

CHANGELOG.md

@@ -0,0 +1,20 @@
+# {{ service-name }} Changelog
+
+All notable changes to this project will be documented in this file. It will follow semantic versioning and each sprint should be tagged with a release. Each developer is in charge of updating this doc before the release.
+
+## 1.0.0 - 2023-03-15
+
+### Added
+
+- New feature X by `[@username](https://github.com/username)`
+- Version navigation.
+- Links to latest released version in previous versions.
+
+### Changed
+
+- What are the minor deltas between each feature
+- What are some of the fixes made
+
+### Removed
+
+- What was actually removed

Makefile

@@ -0,0 +1,11 @@
+build:
+	docker-compose --file docker-compose.yml build
+
+test:
+	docker-compose --file docker-compose.yml --profile test run --rm tests
+
+terminal:
+	docker-compose --file docker-compose.yml run -rm app sh
+
+run:
+	docker-compose --file docker-compose.yml up

README.md

@@ -1,36 +1,63 @@
 # {{ service-name }}
 
-## Build image
+## 🔍 Overview
+```
+What is the purpose or functionality of this repo or application
+```
 
-```bash
-./build.sh
+## ⚠️ Requirements
+```
+What are the dependencies or expectations required in order to run this. This should include minimum versions of Docker. Include the operating system-level dependencies and versions.
+```
+
+### 🌲 Environment vars
+```
+Optional: Any necessary environment variables to set and how to set them (e.g. file vs CLI)
+```
+
+### 🔑 API keys
+```
+Optional: Necessary authentication credentials and where to set them
 ```
 
-## Test image
+
+## ⚙️ Configuration
+```
+Optional: What type of configuration is required and provide instructions in how to achieve that. For example if the user needs an API key or to set environment variables
+```
+
+## 🏁 Getting started
+
+### Build image
 
 ```bash
-./test.sh
+make build
 ```
 
-## Run command inside the container
+### Test image
 
 ```bash
-./terminal.sh
+make test
 ```
 
-## Run stack
+### Run command inside the container
 
 ```bash
-./run.sh
+make terminal
 ```
 
-## Configuration
+### Run stack
 
-Create custom.cfg file. It can be used to store and inject secrets, that should not be commited into the repo.
-Additional local only docker options can be specified in `custom_options` variable, such as volume mounts, i.e.
+```bash
+make run
+```
+
+## 🚀 Deployment
+```
+Optional: Instructions on how to deploy the application or service to Staging environments and Production if relevant
+```
 
+## 🤔 Troubleshooting
 ```
-custom_options="""
-  --volume=`pwd`/../some-package-repo/some_package:/usr/local/lib/python3.7/site-packages/some_package
-"""
+Optional: Your application may have nuances or gotchas, please outline them here for convenience
 ```