mirror of
https://github.com/RfidResearchGroup/ChameleonUltra.git
synced 2026-05-12 11:22:59 -07:00
bugreport templates
This commit is contained in:
@@ -0,0 +1,50 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
***Things to try before submitting a bug report***
|
||||
|
||||
* read the [troubleshooting guide](https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/docs/troubleshooting.md)
|
||||
* check existing [issues](https://github.com/RfidResearchGroup/ChameleonUltra/issues)
|
||||
* use the latest firmware and CLI
|
||||
* for issues specific to another client than the Python CLI, use the corresponding issue tracker. E.g. [here](https://github.com/GameTec-live/ChameleonUltraGUI/issues) for the ChameleonUltraGUI
|
||||
|
||||
***Compilation problems***
|
||||
Try compiling with verbose. Use `make VERBOSE=1` for the firmware and the software/src tools.
|
||||
Include the verbose compilation logs.
|
||||
|
||||
***flashing problems***
|
||||
Have you followed the instructions properly?
|
||||
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior.
|
||||
Explain it as you would do to someone not familiar with the problematic feature.
|
||||
What is the abnormal behavior you observed?
|
||||
E.g.
|
||||
1. Connect '....'
|
||||
2. Execute '....'
|
||||
3. Press button '....'
|
||||
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. For console text and logs, better to dump them as text than image. Attach files if too long.
|
||||
|
||||
**Host (please complete the following information):**
|
||||
- OS and version
|
||||
- for compilation issues, the toolchain version
|
||||
- inside CLI run `hw version` and paste the output here
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Official channels Chameleon Ultra Community
|
||||
url: https://github.com/RfidResearchGroup/ChameleonUltra#official-channels
|
||||
about: Got questions? Ask in *official channels*, not in an issue
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: "[idea]"
|
||||
labels: Request, enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
Please keep in mind we are still at the infancy of the project and a lot has still to be done.
|
||||
|
||||
Have first a look at the [Whitepaper](https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/docs/technical_whitepaper.md), the Wiki [Roadmap](https://github.com/RfidResearchGroup/ChameleonUltra/wiki/Public-Roadmap) and [Wishlist](https://github.com/RfidResearchGroup/ChameleonUltra/wiki/Wishlist).
|
||||
No need for creating issues for well known missing supports, we are already aware :)
|
||||
|
||||
**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.
|
||||
@@ -25,4 +25,10 @@ Read the [available documentation](docs/README.md).
|
||||
* [Downloading and compiling the official CLI](https://www.youtube.com/watch?v=VGpAeitNXH0)
|
||||
* [Downloading ChameleonUltraGUI](https://www.youtube.com/watch?v=rHH7iqbX3nY)
|
||||
|
||||
# Official channels
|
||||
|
||||
Where do you find the community?
|
||||
|
||||
* [RFID Hacking community discord server](https://t.ly/d4_C)
|
||||
* Software/chameleon-dev for firmware and clients development discussions
|
||||
* Devices/chameleon-ultra for usage discussions
|
||||
|
||||
Reference in New Issue
Block a user