Skip to content

Commit 10850f2

Browse files
timonbacksam0r040
andauthored
chore: improve bug report template (springwolf#1118)
Co-authored-by: sam0r040 <[email protected]>
1 parent 936878e commit 10850f2

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,24 @@ assignees: ''
88
---
99

1010
**Describe the bug**
11-
A clear and concise description of what the bug is.
11+
_A clear and concise description of what the bug is._
1212

1313
**Dependencies and versions used**
14-
For example, `springwolf-kafka` version `0.6.1`.
14+
- [x] `springwolf-kafka` version `1.X.0`
15+
- [ ] `springwolf-ui` version `1.X.0`
16+
- [ ] ...
1517

1618
**Code example**
17-
If possible, an example project or snippet that reproduces the bug.
19+
If possible, an example or snippet that reproduces the bug.
20+
21+
> Having a reproducible example highly reduces the time to resolution, allows others to participate, and avoids misunderstandings/communications cycles.
22+
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:
23+
> 1. Fork this repo (`springwolf-core`) in GitHub and `git clone` it
24+
> 2. Adjust classes, etc. in one of the `springwolf-examples`
25+
> 3. Push your local changes to a branch on your fork (`git commit`, `git push`)
26+
> 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.
1827
1928
**Stack trace and error logs**
29+
```text
2030
If an exception has been thrown or an error was logged by springwolf.
31+
```

CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ First off, thanks for taking the time to contribute! ❤️
55
All types of contributions are encouraged and valued.
66
Here, we collected some advice to smooth out the experience for everyone involved.
77

8+
**Table of content**
9+
- [I Have A Question](#i-have-a-question)
10+
- [Reporting a bug](#reporting-a-bug)
11+
- [Contributing code](#contributing-code)
12+
813
> 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.
914
1015
## I Have A Question
@@ -15,17 +20,16 @@ Before you ask a question, it is best to search for existing [Issues](https://gi
1520
In case you have found a suitable issue and still need clarification, you can write your question in this issue.
1621

1722
If you then still feel the need to ask a question and need clarification, we recommend the following:
18-
- Open an [issue](https://github.com/springwolf/springwolf-core/issues)
23+
- Open an [issues](https://github.com/springwolf/springwolf-core/issues)
1924
- Connect with us on discord (see [README](README.md))
2025

21-
## I Want To Contribute
22-
### Raising a bug/feature request
26+
## Reporting a bug
2327

2428
Head over to our [issue](https://github.com/springwolf/springwolf-core/issues?q=is%3Aissue) page and file an issue.
2529

2630
Please search also the closed issues whether your question has been answered before.
2731

28-
### Contributing code
32+
## Contributing code
2933
> **Legal Notice**
3034
>
3135
> 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.

0 commit comments

Comments
 (0)