Skip to content

Change default guidance hint mode#6899

Merged
grzesiek2010 merged 7 commits intogetodk:masterfrom
seadowg:guidance-hint
Sep 25, 2025
Merged

Change default guidance hint mode#6899
grzesiek2010 merged 7 commits intogetodk:masterfrom
seadowg:guidance-hint

Conversation

@seadowg
Copy link
Member

@seadowg seadowg commented Sep 19, 2025

Closes #6639

Why is this the best possible solution? Were any other approaches considered?

I think an obvious additional piece of work that could have been done here would have been to pull out a new view component for the guidance hint. This issue was a small design tweak, and I was timeboxing it to an hour just to finish off my week - I had a quick peak at extracting a view, but it was definitely another chunk of work.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Should just change the default for new and existing projects. Projects that have set a guidance hint mode or already won't be affected. Additionally, I'd expect projects imported from QR codes (like those from Central) to be unaffected as importing from a QR code saves the default value at the time of import.

Before submitting this PR, please make sure you have:

  • added or modified tests for any new or changed behavior
  • run ./gradlew connectedAndroidTest (or ./gradlew testLab) and confirmed all checks still pass
  • added a comment above any new strings describing it for translators
  • added any new strings with date formatting to DateFormatsTest
  • verified that any code or assets from external sources are properly credited in comments and/or in the about file.
  • verified that any new UI elements use theme colors. UI Components Style guidelines

@seadowg seadowg marked this pull request as ready for review September 19, 2025 15:55
@grzesiek2010 grzesiek2010 merged commit 81b9a8b into getodk:master Sep 25, 2025
6 checks passed
@seadowg seadowg deleted the guidance-hint branch September 26, 2025 06:56
@WKobus
Copy link

WKobus commented Sep 26, 2025

Should guidance setting change after upgrade to newest master in projects that were added before this change?

@grzesiek2010
Copy link
Member

grzesiek2010 commented Sep 26, 2025

Should guidance setting change after upgrade to newest master in projects that were added before this change?

You mean from No to Yes - collapsed? If that’s the case, ideally it should, but I’m not sure if it’s important enough to justify writing migration code... @seadowg what do you think?

@seadowg
Copy link
Member Author

seadowg commented Oct 2, 2025

You mean from No to Yes - collapsed? If that’s the case, ideally it should, but I’m not sure if it’s important enough to justify writing migration code... @seadowg what do you think?

It should already I think? If the value is not set, the new default should be used. There's an exception if a project was created from a QR code though as I mentioned in the PR description:

I'd expect projects imported from QR codes (like those from Central) to be unaffected as importing from a QR code saves the default value at the time of import.

Is that all working as expected @WKobus?

@WKobus
Copy link

WKobus commented Oct 3, 2025

I think yea, just to be sure, I added project in Collect v2025.3.0 by scanning app user from central ( hint setting was set to "No") and then upgraded to the newest master, hint setting was still set to "No" it is expected right?

@seadowg
Copy link
Member Author

seadowg commented Oct 3, 2025

I think yea, just to be sure, I added project in Collect v2025.3.0 by scanning app user from central ( hint setting was set to "No") and then upgraded to the newest master, hint setting was still set to "No" it is expected right?

Yeah, that sounds right.

@WKobus
Copy link

WKobus commented Oct 3, 2025

Tested with success

Verified on device with Android 16

Verified cases:

  • Hint setting after adding project by scanning QR
  • Hint setting after upgrading from older version of collect
  • Hint setting after importing QR code

@dbemke
Copy link

dbemke commented Oct 6, 2025

Tested with success

Verified on device with Android 10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make guidance notes available to the user

4 participants