From 98ede09ed81cb9c51f21c1e2f8b41b53b0424537 Mon Sep 17 00:00:00 2001 From: Yannik Bloscheck Date: Thu, 17 Jul 2025 13:19:52 +0200 Subject: [PATCH] [docs] Adding document explaining our user testing Signed-off-by: Yannik Bloscheck --- docs/CONTRIBUTING.md | 2 +- docs/TESTING.md | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/TESTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d9cee937c..6cdd3d082 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -70,7 +70,7 @@ While we strive to help onboard new developers we don't have enough time to guid Please help us: - processing users questions and feedback in chats, app stores, email and social media and creating follow-up issues or updating existing ones - reproducing and triaging reported bugs -- testing upcoming features and bug fixes for Android, iOS and desktop versions +- [testing upcoming features and bug fixes for Android, iOS and desktop versions](TESTING.md) - keeping [issues](https://codeberg.org/comaps/comaps/issues) in order (check for duplicates, organize, assign labels, link related issues, etc.) - composing nice user-centric release notes and news items - etc. diff --git a/docs/TESTING.md b/docs/TESTING.md new file mode 100644 index 000000000..4b32217d2 --- /dev/null +++ b/docs/TESTING.md @@ -0,0 +1,25 @@ +# Testing + +User testing is an important part of the pre-release process to make sure no bugs make it into the final release version. + +You can install test builds, which are pre-release versions of our app, and try to find new bugs before they make it to more people. You should be aware though that those test builds can be more unstable and prone to errors than the released versions. So don't use those test builds, if you really need to rely on our app working as stable and bug-free as possible. + +The main focus of testing those test builds should always be the newly introduced or changed parts. +[Finding and reporting other already existing bugs](https://codeberg.org/comaps/comaps/issues) of course is important too, but it is not the principal purpose of the test builds. + +This is the process for the different platforms: + +## Android +- A new Issue is created for every Android test build. +- The Issue includes the APK, that needs to be tested, and notes of what changed with this test build. +- Comments and problems found with the specific test build should be noted in the Issue. +- The existing test build Issue will be closed with a link to the new test build Issue, if a new test build becomes available. +- New test builds also usually get announced in the chats. + +## iOS +- A new Issue is created for every iOS test build. +- The Issue includes the signup link for the TestFlight and notes of what changed with this test build. +- The available space for beta testers in TestFlight is limited and all spots might be filled already. We regularly remove inactive testers and sometimes add more spots though. So if the beta is full, maybe check again at some point later. +- Comments and problems found with the specific test build should be noted in the Issue. +- The existing test build Issue will be closed with a link to the new test build Issue, if a new test build becomes available. +- TestFlight normally notifies existing testers of a new test build and new test builds also usually get announced in the chats. \ No newline at end of file