From 10850f2addedc0e04d769ffa5ede557c7c75eea5 Mon Sep 17 00:00:00 2001 From: Timon Back Date: Fri, 6 Dec 2024 15:15:23 +0100 Subject: [PATCH] chore: improve bug report template (#1118) Co-authored-by: sam0r040 <93372330+sam0r040@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 17 ++++++++++++++--- CONTRIBUTING.md | 12 ++++++++---- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2b3a0c784..ada628a74 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,13 +8,24 @@ assignees: '' --- **Describe the bug** -A clear and concise description of what the bug is. +_A clear and concise description of what the bug is._ **Dependencies and versions used** -For example, `springwolf-kafka` version `0.6.1`. +- [x] `springwolf-kafka` version `1.X.0` +- [ ] `springwolf-ui` version `1.X.0` +- [ ] ... **Code example** -If possible, an example project or snippet that reproduces the bug. +If possible, an example or snippet that reproduces the bug. + +> Having a reproducible example highly reduces the time to resolution, allows others to participate, and avoids misunderstandings/communications cycles. +You can support by adjusting one of the [springwolf examples](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples), so that it reproduces your scenario: +> 1. Fork this repo (`springwolf-core`) in GitHub and `git clone` it +> 2. Adjust classes, etc. in one of the `springwolf-examples` +> 3. Push your local changes to a branch on your fork (`git commit`, `git push`) +> 4. Open a `Pull Request` (a notification will appear in your fork as soon as you push your branch), the title should include `reproduce` and ideally the link to the issue. **Stack trace and error logs** +```text If an exception has been thrown or an error was logged by springwolf. +``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ce812e3c..00f350f1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,11 @@ First off, thanks for taking the time to contribute! ❤️ All types of contributions are encouraged and valued. Here, we collected some advice to smooth out the experience for everyone involved. +**Table of content** +- [I Have A Question](#i-have-a-question) +- [Reporting a bug](#reporting-a-bug) +- [Contributing code](#contributing-code) + > And if you like the project, but just don't have time to contribute, that's fine. Publicity in the form of github star, a tweet, mentioning in your project's readme and/or telling a friend (at a meetup) help as well. ## I Have A Question @@ -15,17 +20,16 @@ Before you ask a question, it is best to search for existing [Issues](https://gi In case you have found a suitable issue and still need clarification, you can write your question in this issue. If you then still feel the need to ask a question and need clarification, we recommend the following: -- Open an [issue](https://github.com/springwolf/springwolf-core/issues) +- Open an [issues](https://github.com/springwolf/springwolf-core/issues) - Connect with us on discord (see [README](README.md)) -## I Want To Contribute -### Raising a bug/feature request +## Reporting a bug Head over to our [issue](https://github.com/springwolf/springwolf-core/issues?q=is%3Aissue) page and file an issue. Please search also the closed issues whether your question has been answered before. -### Contributing code +## Contributing code > **Legal Notice** > > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.