♻️ Add Devops notes to PR template (#4025)

* Add Devops nodes to PR template * Change request @odeimaiz * listing * Change request @pcrespov * Change requests @pcrespov * Update PR template with requests @sanderegg * Update PR template with requests @sanderegg - 2 --------- Co-authored-by: Dustin Kaiser <[email protected]> Co-authored-by: Pedro Crespo-Valero <[email protected]> Co-authored-by: Dustin Kaiser <[email protected]>
ITISFoundation · Apr 12, 2023 · 834ce8b · 834ce8b
1 parent 580f666
commit 834ce8b
Showing 1 changed file with 26 additions and 5 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,15 +3,18 @@
   WIP: work in progress
   🐛    Fix a bug.
   ✨    Introduce new features.
-  ♻️     Refactor code.
+  🎨    Enhance existing feature.
+  ♻️    Refactor code.
   🚑️    Critical hotfix.
-  ⚗️     Perform experiments.
-  ⬆️     Upgrade dependencies.
+  ⚗️    Perform experiments.
+  ⬆️    Upgrade dependencies.
   📝    Add or update documentation.
   🔨    Add or update development scripts.
   🔒️    Fix security issues.
-  ⚠️     Changes in devops configuration
-  🗃️    Migration of database
+  ⚠️    Changes in ops configuration etc. are required before deploying. 
+        [ Please add a link to the associated ops-issue or PR, such as in https://github.com/ITISFoundation/osparc-ops-environments or https://git.speag.com/oSparc/osparc-infra ]
+  🗃️    Database table changed (relevant for devops).
+
 
 or from https://gitmoji.dev/
 -->
@@ -33,3 +36,21 @@ or from https://gitmoji.dev/
 ## How to test
 
 <!-- Give REVIEWERS some hits or code snippets on how could this be tested -->
+
+## DevOps Checklist
+<!--
+
+Some checks that might help your code run stable on production, and help devops assess criticality.
+
+Modified from https://oschvr.com/posts/what-id-like-as-sre/
+
+
+- How can DevOps check the health of the service ?
+- How can DevOps safely and gracefully restart the service ?
+- How and why would this code fail ?
+- What kind of metrics are you exposing ?
+- Is there any documentation/design specification for the service ?
+- How (e.g. through which loglines) can DevOps detect unexpected situations that require escalation to human ?
+- What are the resource limitations (CPU, RAM) expected for this service ?
+- Are all relevant variables documented and adjustable via environment variables (i.e. no hardcoded magic numbers) ?
+-->