Add issue templates
There are wa too useless issues lately, and I'm starting to get tired of this...
This commit is contained in:
parent
7e733d369d
commit
79a7b1f059
36
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
36
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**DISCLAIMER**
|
||||
- Please, before reporting a bug make sure you have read the javadocs. If, by reading the issue, I realize you skipped this step it is very likely I will close the issue without even answering, marking it as 'invalid'! MaterialFX documentation is gold, make use of it!
|
||||
- Some people seem to not realize that MaterialFX has a demo, basically a workbech for MaterialFX controls, and that it is a very valuable resource since there are a LOT of examples on how to use them.
|
||||
If your issue is about "not knowing how to do this and that" please before asking check the demo maybe the answer is already there.
|
||||
- Often the issues are about controls customization. Please before reporting the issue make sure to check the CSS files (both in [materialfx](https://github.com/palexdev/MaterialFX/tree/main/materialfx/src/main/resources/io/github/palexdev/materialfx/css) and [demo](https://github.com/palexdev/MaterialFX/tree/main/demo/src/main/resources/io/github/palexdev/materialfx/demo/css) modules) as the answer may already be there.
|
||||
**Now that you have read the disclaimer you can remove it and proceed with the issue report**
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**[MRE](https://bit.ly/3k5gTJf)(Minimal Reproducible Example)**
|
||||
- This is almost mandatory, if I can't reproduce the issue then it doesn't exist
|
||||
- The preferred way to submit a MRE would be to zip it and attach it here
|
||||
- If possible the MRE should make use of Gradle(preferred) or Maven to quickly setup the project
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
15
.github/ISSUE_TEMPLATE/general.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/general.md
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
name: General
|
||||
about: This is for anything else that is not a bug or a feature request
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**DISCLAIMER**
|
||||
- Please, before reporting this issue make sure you have read the javadocs. If, by reading the issue, I realize you skipped this step it is very likely I will close the issue without even answering, marking it as 'invalid'! MaterialFX documentation is gold, make use of it!
|
||||
- Some people seem to not realize that MaterialFX has a demo, basically a workbech for MaterialFX controls, and that it is a very valuable resource since there are a LOT of examples on how to use them.
|
||||
If your issue is about "not knowing how to do this and that" please before asking check the demo maybe the answer is already there.
|
||||
- Often the issues are about controls customization. Please before reporting the issue make sure to check the CSS files (both in [materialfx](https://github.com/palexdev/MaterialFX/tree/main/materialfx/src/main/resources/io/github/palexdev/materialfx/css) and [demo](https://github.com/palexdev/MaterialFX/tree/main/demo/src/main/resources/io/github/palexdev/materialfx/demo/css) modules) as the answer may already be there.
|
||||
**Now that you have read the disclaimer you can remove it and proceed with the issue report**
|
Loading…
x
Reference in New Issue
Block a user