Skip to content

Commit f9c4123

Browse files
committed
cleanup
1 parent 0355879 commit f9c4123

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+4-20
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
⬆️ Upgrade dependencies.
1111
📝 Add or update documentation.
1212
🔨 Add or update development scripts.
13+
✅ Add, update or pass tests.
1314
🔒️ Fix security issues.
1415
⚠️ Changes in ops configuration etc. are required before deploying.
1516
[ 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 ]
@@ -28,13 +29,7 @@ or from https://gitmoji.dev/
2829

2930

3031
## Related issue/s
31-
32-
<!-- Link pull request to an issue
33-
SEE https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
34-
35-
- resolves ITISFoundation/osparc-issues#428
36-
- fixes #26
37-
-->
32+
<!-- LINK to other issues and add prefix `closes`, `fixes`, `resolves`-->
3833

3934

4035
## How to test
@@ -43,17 +38,6 @@ or from https://gitmoji.dev/
4338

4439
## Dev-ops checklist
4540

46-
- [ ] No ENV changes or I properly updated ENV ([read the instruction](https://git.speag.com/oSparc/osparc-ops-deployment-configuration/-/blob/configs/README.md?ref_type=heads#how-to-update-env-variables))
41+
- [ ] No ENV changes or I properly updated ENV (i.e. repo.config)
4742

48-
<!-- Some checks that might help your code run stable on production, and help devops assess criticality.
49-
Modified from https://oschvr.com/posts/what-id-like-as-sre/
50-
51-
- How can DevOps check the health of the service ?
52-
- How can DevOps safely and gracefully restart the service ?
53-
- How and why would this code fail ?
54-
- What kind of metrics are you exposing ?
55-
- Is there any documentation/design specification for the service ?
56-
- How (e.g. through which loglines) can DevOps detect unexpected situations that require escalation to human ?
57-
- What are the resource limitations (CPU, RAM) expected for this service ?
58-
- Are all relevant variables documented and adjustable via environment variables (i.e. no hardcoded magic numbers) ?
59-
-->
43+
<!-- Details in docs/devops-checklist.md -->

docs/devops-checklist.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Devops checklist
2+
3+
- No ENV changes or I properly updated ENV ([read the instruction](https://git.speag.com/oSparc/osparc-ops-deployment-configuration/-/blob/configs/README.md?ref_type=heads#how-to-update-env-variables))
4+
5+
- Some checks that might help your code run stable on production, and help devops assess criticality.
6+
- How can DevOps check the health of the service ?
7+
- How can DevOps safely and gracefully restart the service ?
8+
- How and why would this code fail ?
9+
- What kind of metrics are you exposing ?
10+
- Is there any documentation/design specification for the service ?
11+
- How (e.g. through which loglines) can DevOps detect unexpected situations that require escalation to human ?
12+
- What are the resource limitations (CPU, RAM) expected for this service ?
13+
- Are all relevant variables documented and adjustable via environment variables (i.e. no hardcoded magic numbers) ?
14+
15+
Ref: Modified from https://oschvr.com/posts/what-id-like-as-sre/

0 commit comments

Comments
 (0)