summaryrefslogtreecommitdiff
path: root/lib/jive/templates
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-02-10 14:47:47 -0700
committermo khan <mo@mokhan.ca>2025-02-10 14:47:47 -0700
commitb2bf2e20fe0bd813e17e311fe1df67483f4b192b (patch)
tree041455ae7fc3d09482dee7b6a3b0de12bdff31e1 /lib/jive/templates
parent5f6131b49c3d559ea717e401accd15f8c2193e2f (diff)
Merge code from gem because the git history is lostHEADmain
Diffstat (limited to 'lib/jive/templates')
-rw-r--r--lib/jive/templates/bug.md45
-rw-r--r--lib/jive/templates/feature.md49
-rw-r--r--lib/jive/templates/play_book.md81
-rw-r--r--lib/jive/templates/pull_request.md51
4 files changed, 226 insertions, 0 deletions
diff --git a/lib/jive/templates/bug.md b/lib/jive/templates/bug.md
new file mode 100644
index 0000000..8da630a
--- /dev/null
+++ b/lib/jive/templates/bug.md
@@ -0,0 +1,45 @@
+---
+title: "Defect Template"
+description: |
+---
+
+### Summary
+
+<!-- Summarize the defect encountered concisely. -->
+
+### Steps to reproduce
+
+<!--
+Describe how one can reproduce the issue - this is very important.
+Please use an ordered list.
+-->
+
+### Example Project
+
+<!--
+Please create an example project here on GitHub.com that exhibits the problematic
+behavior, and link to it here in the bug report.
+
+If you are using an older version of GitHub.com,
+this will also determine whether the bug is fixed
+in a more recent version.
+-->
+
+### What is the current *bug* behavior?
+
+<!-- Describe what actually happens. -->
+
+### What is the expected *correct* behavior?
+
+<!-- Describe what you should see instead. -->
+
+### Relevant logs and/or screenshots
+
+<!--
+Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code.
+-->
+
+### Possible fixes
+
+<!-- If you can, link to the line of code that might be responsible for the problem. -->
diff --git a/lib/jive/templates/feature.md b/lib/jive/templates/feature.md
new file mode 100644
index 0000000..bc6cba6
--- /dev/null
+++ b/lib/jive/templates/feature.md
@@ -0,0 +1,49 @@
+---
+title: "Feature Template"
+description: |
+ This is used to break-up a large piece of work into smaller,
+ discrete tasks that can move independently through the build workflow steps.
+---
+
+As a `[persona]`, I `[want to]`, so that `[goal]`.
+
+# Why are we doing this work?
+
+<!--
+A brief explanation of the why, not the what or how.
+Assume the reader doesn't know the background and won't have time to dig-up
+information from comment threads.
+-->
+
+# Tasks
+
+<!--
+Steps and the parts of the code that will need to get updated.
+The plan can also call-out responsibilities for other team members or teams.
+
+e.g.:
+
+- [ ] ~frontend Step 1
+ - [ ] `@person` Step 1a
+- [ ] ~frontend Step 2
+- [ ] ~backend Step 3
+-->
+
+# Relevant links
+
+<!--
+Information that developers might need to refer to when implementing the issue.
+
+- [Design Issue](https://github.com/xlgmokha/project/issues/<id>)
+- [Similar implementation](https://github.com/xlgmokha/project/pull/<id>)
+-->
+
+# Non-functional requirements
+
+<!-- Add details for required items and delete others. -->
+
+- [ ] Documentation:
+- [ ] Feature flag:
+- [ ] Observability:
+- [ ] Performance:
+- [ ] Testing:
diff --git a/lib/jive/templates/play_book.md b/lib/jive/templates/play_book.md
new file mode 100644
index 0000000..f53ef48
--- /dev/null
+++ b/lib/jive/templates/play_book.md
@@ -0,0 +1,81 @@
+# Title
+
+<!--
+The title should be the name of the alert (e.g., Generic Alert_AlertTooGeneric).
+-->
+
+# Overview
+
+<!--
+Address the following:
+
+* What does this alert mean?
+* Is it a paging or an email-only alert?
+* What factors contributed to the alert?
+* What parts of the service are affected?
+* What other alerts accompany this alert?
+* Who should be notified?
+-->
+
+# Alert Severity
+
+<!--
+Indicate the reason for the severity (email or paging) of the alert and the
+impact of the alerted condition on the system or service.
+-->
+
+# Verification
+
+<!--
+Provide specific instructions on how to verify that the condition is ongoing.
+-->
+
+# Troubleshooting
+
+<!--
+
+List and describe debugging techniques and related information sources.
+Include links to relevant dashboards. Include warnings.
+
+Address the following:
+
+* What shows up in the logs when this alert fires?
+* What debug handlers are available?
+* What are some useful scripts or commands?
+* What sort of output do they generate?
+* What are some additional tasks that need to be done after the alert is resolved?
+
+-->
+
+# Solution
+
+<!--
+
+List and describe possible solutions for addressing this alert.
+
+Address the following:
+
+* How do I fix the problem and stop this alert?
+* What commands should be run to reset things?
+* Who should be contacted if this alert happened due to user behavior?
+* Who has expertise at debugging this issue?
+
+-->
+
+# Escalation
+
+<!--
+
+List and describe paths of escalation.
+Identify whom to notify (person or team) and when.
+If there is no need to escalate, indicate that.
+
+-->
+
+# Related Links
+
+<!--
+
+Provide links to relevant related alerts, procedures, and overview documentation.
+
+-->
diff --git a/lib/jive/templates/pull_request.md b/lib/jive/templates/pull_request.md
new file mode 100644
index 0000000..14288ee
--- /dev/null
+++ b/lib/jive/templates/pull_request.md
@@ -0,0 +1,51 @@
+---
+title: "Pull Request Template"
+checklist:
+- [ ] Clear description explaining the relevancy of the contribution.
+- [ ] Unit, integration, and system tests.
+- [ ] Regression and bugs are covered with tests.
+- [ ] [Performance guidelines](https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html)
+- [ ] [Secure coding guidelines](https://docs.gitlab.com/ee/development/secure_coding_guidelines.html)
+- [ ] Documentation Updated
+---
+
+# Why is this needed?
+
+## What does this do?
+
+<!--
+ Include a summary of the change and which issue is fixed.
+ Include relevant motivation and context.
+ List any dependencies that are required for this change.
+-->
+
+Fixes # (issue)
+
+### Screenshots
+
+Before:
+
+![Before][before]
+
+After:
+
+![After][after]
+
+## Type of change
+
+<!-- Delete options that are not relevant. -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## Verification Plan
+
+<!-- How are we going to verify this change? -->
+
+- [ ] Step 1
+- [ ] Step 2
+
+[after]: https://user-images.githubusercontent.com/x/y.png
+[before]: https://user-images.githubusercontent.com/x/y.png