Skip to content

Commit

Permalink
added issue / pull request templates (#538)
Browse files Browse the repository at this point in the history
* added issue templates

* cosmetics

* added pull request template
  • Loading branch information
roblaszczak authored Jan 13, 2025
1 parent 2a85241 commit d48b8ab
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.md
Original file line number Diff line number Diff line change
@@ -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. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.md
Original file line number Diff line number Diff line change
@@ -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

```
42 changes: 42 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit d48b8ab

Please sign in to comment.