openbikesensor / openbikesensor/OpenBikeSensorFirmware
Find a way to create and report an error from the OBS
Open
Nobody has claimed this yet.
development
enhancement
- Dominant language
- C++
- Stars
- 124
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Description
Currently we are quiet blind if an unexpected condition on the device ocures. Might be we find an easy way to create such a report.
A idea could be:
- write a error report file to the SD card
should include exact version number and as much context data as possible / needed - once in configuration mode offer to upload the report to github
https://developer.github.com/v3/issues/#create-an-issue / https://eric.blog/2016/01/08/prefilling-github-issues/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the device's unexpected-condition handling and the configuration mode entry point. Define the report contents, including the exact version and required context, then assess the linked GitHub Issues API and SD-card approach; done means a reproducible report can be created, stored, and offered for upload.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- arduino, cpp, github
- Domain
- embedded-iot
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100