Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve bug report template #1118

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading