From d48b8ab414fb733b6f324bd0b2a071f768fcc649 Mon Sep 17 00:00:00 2001
From: Robert Laszczak <roblaszczak@gmail.com>
Date: Mon, 13 Jan 2025 17:48:01 +0100
Subject: [PATCH] added issue / pull request templates (#538)

* added issue templates

* cosmetics

* added pull request template
---
 .github/ISSUE_TEMPLATE/1_bug_report.md      | 36 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/2_feature_request.md | 24 ++++++++++++
 .github/pull_request_template.md            | 42 +++++++++++++++++++++
 3 files changed, 102 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.md b/.github/ISSUE_TEMPLATE/1_bug_report.md
new file mode 100644
index 00000000..46f49a8e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1_bug_report.md
@@ -0,0 +1,36 @@
+## Bug Report
+
+<!--
+The resources of our team are limited.
+If you want to speed up fixing the problem, please follow the guidelines below.
+It will help us to understand and reproduce the issue and to find a solution faster.
+-->
+
+### Steps to reproduce
+
+<!--
+⚠️  Important: Problem Reproduction Steps  ⚠️
+To help us investigate and fix your issue effectively, we need clear reproduction steps.
+Include relevant code snippets and descriptions that demonstrate the problem.
+-->
+
+docker-compose.yml
+```yaml
+
+```
+
+```go
+// Your reproduction code goes here
+```
+
+### Expected behavior
+
+<!-- What should happen -->
+
+### Actual behavior
+
+<!-- What happens instead -->
+
+### Possible solution
+
+<!-- Consider submitting a pull request - it will help us provide faster feedback on your solution. -->
diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.md b/.github/ISSUE_TEMPLATE/2_feature_request.md
new file mode 100644
index 00000000..d7787d76
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2_feature_request.md
@@ -0,0 +1,24 @@
+## Feature request
+
+<!--
+The resources of our team are limited. If you want to
+We will be able to help you faster if you follow the guidelines below.
+It will help us to understand and reproduce the issue and to find a solution faster.
+-->
+
+### Description
+
+<!-- Describe the new feature clearly and concisely -->
+
+### Example use case
+
+<!--
+Provide an example of how you would use this feature. 
+It will help us to understand the context of the request and to find the best solution.
+-->
+
+#### How it can look like in code
+
+```go
+
+```
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..e0ad400d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,42 @@
+<!--
+Thanks for contributing to Watermill!
+
+The following template aims to help contributors write a good description for their pull requests.
+**The more information you provide, the faster we will be able to review and merge your PR.**
+
+Feel free to skip this template for minor changes like typo fixes.
+
+-->
+
+### Motivation / Background
+
+<!--
+
+Explain the purpose of this Pull Request:
+- What issue or bug does it address?
+- What new functionality does it add?
+- Why are these changes needed?
+For bug fixes, include "Fixes #ISSUE" to automatically link to the related issue.
+
+-->
+
+### Detail
+
+
+### Alternative approaches considered (if applicable)
+
+<!-- If applicable, describe alternative approaches you considered and why you chose this one. -->
+
+### Checklist
+
+The resources of our team are limited. **There are a couple of things that you can do to help us merge your PR faster**:
+
+- [ ] I wrote tests for the changes.
+- [ ] All tests are passing.
+  - If you are testing a Pub/Sub, you can start Docker with `make up`.
+  - You can start with `make test_short` for a quick check.
+  - If you want to run all tests, use `make test`.
+- [ ] Code has no breaking changes.
+- [ ] _(If applicable)_ documentation on [watermill.io](https://watermill.io/) is updated.
+  - Documentation is built in the [github.com/ThreeDotsLabs/watermill/docs](https://github.com/ThreeDotsLabs/watermill/tree/master/docs).
+  - You can find development instructions in the [DEVELOP.md](https://github.com/ThreeDotsLabs/watermill/tree/master/docs/DEVELOP.md).
\ No newline at end of file