|
| 1 | +<!-- |
| 2 | +Thanks for contributing to Watermill! |
| 3 | +
|
| 4 | +The following template aims to help contributors write a good description for their pull requests. |
| 5 | +**The more information you provide, the faster we will be able to review and merge your PR.** |
| 6 | +
|
| 7 | +Feel free to skip this template for minor changes like typo fixes. |
| 8 | +
|
| 9 | +--> |
| 10 | + |
| 11 | +### Motivation / Background |
| 12 | + |
| 13 | +<!-- |
| 14 | +
|
| 15 | +Explain the purpose of this Pull Request: |
| 16 | +- What issue or bug does it address? |
| 17 | +- What new functionality does it add? |
| 18 | +- Why are these changes needed? |
| 19 | +For bug fixes, include "Fixes #ISSUE" to automatically link to the related issue. |
| 20 | +
|
| 21 | +--> |
| 22 | + |
| 23 | +### Detail |
| 24 | + |
| 25 | + |
| 26 | +### Alternative approaches considered (if applicable) |
| 27 | + |
| 28 | +<!-- If applicable, describe alternative approaches you considered and why you chose this one. --> |
| 29 | + |
| 30 | +### Checklist |
| 31 | + |
| 32 | +The resources of our team are limited. **There are a couple of things that you can do to help us merge your PR faster**: |
| 33 | + |
| 34 | +- [ ] I wrote tests for the changes. |
| 35 | +- [ ] All tests are passing. |
| 36 | + - If you are testing a Pub/Sub, you can start Docker with `make up`. |
| 37 | + - You can start with `make test_short` for a quick check. |
| 38 | + - If you want to run all tests, use `make test`. |
| 39 | +- [ ] Code has no breaking changes. |
| 40 | +- [ ] _(If applicable)_ documentation on [watermill.io](https://watermill.io/) is updated. |
| 41 | + - Documentation is built in the [github.com/ThreeDotsLabs/watermill/docs](https://github.com/ThreeDotsLabs/watermill/tree/master/docs). |
| 42 | + - You can find development instructions in the [DEVELOP.md](https://github.com/ThreeDotsLabs/watermill/tree/master/docs/DEVELOP.md). |
0 commit comments