summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Sorriaux <stephen.sorriaux@gmail.com>2020-05-09 10:39:22 +0000
committerStephen Sorriaux <stephen.sorriaux@gmail.com>2020-05-09 10:46:37 +0000
commit222f861b908c54fb85e2fe840722e1d046248676 (patch)
tree9433ba7129de888ca486fc13bbf0fa19ae5cf00b
parentb880ae66b9f921394e2e756f2466b5e110e040bb (diff)
downloadkazoo-feat/add-github-templates.tar.gz
feat(chore): using Github templates for issues and PRsfeat/add-github-templates
Let's make our life a little easier using those templates. See https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates for reference.
-rw-r--r--.github/ISSUE_TEMPLATE/bug-report.md31
-rw-r--r--.github/ISSUE_TEMPLATE/enhancement.md13
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md12
3 files changed, 56 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 0000000..db670b2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,31 @@
+---
+name: Bug Report
+about: Report a bug encountered while using Kazoo
+
+---
+
+<!-- Please use this template while reporting a bug and provide as much info as possible. Thank you.-->
+
+
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Snippet to Reproduce the Problem
+
+```COPY/PASTE the snippet here (omit any sensitive information)```
+
+## Logs with logging in DEBUG mode
+
+```COPY/PASTE the result of the snippet here (omit any sensitive information)```
+
+## Specifications
+
+ - Kazoo version:
+ - Result of `pip list` command:
+ - Zookeeper version:
+ - Zookeeper configuration: put here any useful ZK configuration (authentication, encryption, number of ZK members, number of (concurrent?) clients, Java version, krb5 version, etc.)
+ - Python version:
+ - OS:
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
new file mode 100644
index 0000000..8884a22
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,13 @@
+---
+name: Enhancement Request
+about: Suggest an enhancement for Kazoo
+
+---
+
+<!-- Please only use this template for submitting enhancement requests -->
+
+## What would you like to be added
+
+
+## Why is this needed
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..41a81be
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+Fixes #
+
+## Why is this needed?
+
+## Proposed Changes
+
+ - change 1
+ - change 2
+ - ...
+
+## Does this PR introduce any breaking change?
+