ayufan/steam-deck-tools
1
0
Fork 0
mirror of https://github.com/ayufan/steam-deck-tools.git synced 2026-01-20 07:20:27 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update development.md

Browse source
This commit is contained in:
Kamil Trzciński 2022-12-13 22:07:28 +01:00 committed by GitHub
parent 9309b72df5
commit 566ea652a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/development.md
View file

@ -3,3 +3,30 @@
It should be enough to run `scripts/build.bat` to see binaries in `build-release/`.
You might also run `scripts/test_debug.bat` which will build and run built version.
## Data tracking
To aid the application development this project uses [Sentry.io](https://sentry.io/)
to track all exceptions raised by the application. It is essential to identify bugs
and fix them with minimal user intervention superseeding the need to user
[troubleshooting](troubleshooting.md).
As part of Sentry error tracking the following information is being sent and is logged
including, but not only:
- Windows Version
- .NET Framework Version
- Application Version
- Unique Machine ID
Additionally for statistic purposes the Machine ID and Application Version might
be tracked as part of Update process to see active user-base vs version used.
The Unique Machine ID is one time generated GUID that is persisted on the first start
of an application.
Application for auto-update purposes checks for latest release on a start,
or every 24 hours.
All information being logged can be seen in a publically available source code
of this application.