meta: fulfil GNOME Circle app criteria #19

mahlzahn commented 2025年12月02日 19:47:04 +01:00

Following criteria are copied from GNOME’s App Criteria.

Required General App Criteria

General Quality

• Basic features and functionality work as expected
  • (削除) #21 bug: clicking on redactions unexpectedly removes them (削除ここまで) → !62 fix: move deletion action into right click context menu
  • (削除) #20 feat: undo/redo (削除ここまで) → !75 feat: add undo/redo history, !102 feat: add undo/redo entries in right-click context menu, !127 feat: improve user interface by moving buttons around
  • (削除) #28 feat: page indicator and selector (削除ここまで) → !52 feat: add current page indicator and selector
• Easy to get started on first run
• User reviews are generally positive. No repeated complaints about critical issues.
• No known issues that can lead to data loss
  • (削除) #9 bug: redactions lost on accidental app closing (削除ここまで) → !22 fix: prevent data loss for unsaved redactions, !125 fix: prevent data loss asking before quitting application
  • (削除) #78, #90 bug: saving files (sometimes?) does not work (削除ここまで) → !92 fix: allow repeated saving to same file path

Maintenance

• Evidence of recent development activity
• Confidence in the maintainers' ability to reliably maintain the project
• Being careful about inflicting harm like data loss on users
• Keeping up with maintenance to at least using a supported runtime on Flathub

Technology Basis

• Uses GTK 4 + Libadwaita
• Uses the GNOME runtime on Flathub

Design

• Follows the Human Interface Guidelines
• Dark mode works
  • Contrast is maintained everywhere (no dark font color on dark background etc.)
  • No white surfaces (apart from external media etc)

Content

• Does not contradict the intentions of the GNOME Code of Conduct
• Does not promote cryptocurrencies or related services

Legal

• Has an OSI-approved license
• No contributor license agreement (CLA)
• The software must work without installing proprietary software

Metadata

• App metainfo is valid (appstreamcli validate ./path/to/<app-id>.metainfo.xml passes)
• App name follows guidelines
• App icon follows guidelines
• Screenshot quality (more info)
• "Summary" quality (more info)
• .doap-file in repository exists and is up-to-date (more info)
  • → !48 chore: add doap file
  • → !54 ... rename doap file
• Hardware support information is present
  • → !27 chore: adjust Appstream meta data
• Content rating information is present

Accessibility

• Can navigate to all elements via keyboard and use them
• Uses standard keyboard shortcuts (more info)
• High-contrast mode works
• Large text mode works
• Sufficient contrast between content and background
• Works with Orca (activate via Alt+Super+S)
  • Image buttons have a tooltip

Repository

• Passing CI builds of the app
  • → !82 chore(ci): add automated flatpak builds on GNOME Gitlab for pull requests
• Public issue tracker and code repository
  • The repository does not need to be hosted on GNOME's GitLab instance.
• Making contributors aware that the GNOME Code of Conduct applies to the project
  • For example linking to the Code of Conduct in the project's README

Recommended General App Criteria

• Builds Flatpak in Builder out of the box
• Build system is Meson, Automake, or CMake

Circle App Criteria

• Available on Flathub
  • Available for x86_64 and aarch64
  • (削除) #6 meta: publish on flathub for easier installation and discoverability (削除ここまで)
• No GNOME branding
  • The app may not use GNOME in its name or its author field and may not promote the app as official GNOME software. However, after inclusion into GNOME Circle, the maintainers are encouraged to promote the app as being part of "GNOME Circle", using the Circle branding.
• App ID is valid
  • Valid app IDs are
    • IDs of the form <public-suffix>.<something>.<app>, where https://<something>.<public-suffix>/.well-known/org.flathub.VerifiedApps.txt can be controlled by the user
    • IDs of the form com.github.<user>.<app>, io.github.<user>.<app>, com.gitlab.<user>.<app>, or io.gitlab.<user>.<app>.
    • IDs that are on the list of legacy apps
  • Invalid app IDs
    • Does not have the form org.gnome.<app>, expect the cases listed in the valid app IDs above
    • Follows Flatpak requirements like replacing - with _ in app IDs
• The app support internationalization and is connected to some localization infrastructure.

Additional criteria (not from GNOME's list)

• Description of <releases> in metadata for stable releases, see here and here.

GNOME Circle application submission

https://gitlab.gnome.org/Teams/Circle/-/issues/264

1. Review (Tobias Bernard)

Hi, thanks for your interest in Circle! Not a proper review yet, but a few initial things I came across:

• There seems to be no zoom/pan (except after resizing the window), which is really needed for an app like this. I'd look at Loupe as an example for how to do this well behavior-wise with various types of input.
  • (削除) #107 feat: improve zoom accessibility (削除ここまで) → !177 feat: add pinch to zoom and improve zooming behaviour
• The non-flat "Save As" button on the top left is a bit odd, I'd use a more standard pattern here with "Open" in the top left and "Save" somewhere on the right, both with an icon
  • → !127 feat: improve user interface by moving buttons around, !130 feat: improve saving experience
• Would be good to set a custom cursor that makes it obvious you're about to draw rectangles
  • → !105 feat: use crosshair cursor for rectangle selection

2. Review (Martin Abente Lahaye)

not sure, how much CI is required here: CI for building?

• Yeah, making sure it's building fine would be enough.
  • → !82 chore(ci): add automated flatpak builds on GNOME Gitlab for pull requests

3. Review (Tobias Bernard)

Thanks for the updates! Here are a few more things I found testing the latest version:

• This should use a more standard empty state with a title and subtitle, and a pill button instead of the headerbar open button. I'd look at Papers as an example.

  Screenshots

  Censor	Papers
  image	image

• Would it be possible to navigate all pages in a single scrollview, like in Papers? The page-wise navigation is a bit cumbersome. If this is technically not possible I'd at least look into adding some more ergonomic pager buttons, maybe as an overlay in the bottom left like in Loupe.

  • #10 feat: continuous page view
  Screenshot

  image

A few papercuts with the zoom functionality:

• Zoom via Ctrl+Scroll is too slow/sensitive, I'd copy the behavior from Loupe or Papers here
• I'd be good to add panning with the middle mouse button,like in other similar apps
• Pinch to zoom behaves weirdly, it seems as though it doesn't actually zoom into where the cursor is? Here, too, I'd look at Loupe or Papers for the exact behavior.
• Zoom needs some UI controls, either in the primary menu (like in Web) or as an overlay (like in Loupe)

Following criteria are copied from [GNOME’s App Criteria](https://gitlab.gnome.org/Teams/Releng/AppOrganization/-/blob/080e7b11a2285b1f08739a2ad9e11796b2039bd8/AppCriteria.md). ### Required General App Criteria <details open><summary><h4>General Quality</h4></summary> - [x] Basic features and functionality work as expected - ~#21 bug: clicking on redactions unexpectedly removes them~ → !62 fix: move deletion action into right click context menu - ~#20 feat: undo/redo~ → !75 feat: add undo/redo history, !102 feat: add undo/redo entries in right-click context menu, !127 feat: improve user interface by moving buttons around - ~#28 feat: page indicator and selector~ → !52 feat: add current page indicator and selector - [x] Easy to get started on first run - [x] User reviews are generally positive. No repeated complaints about critical issues. - [x] No known issues that can lead to data loss - ~#9 bug: redactions lost on accidental app closing~ → !22 fix: prevent data loss for unsaved redactions, !125 fix: prevent data loss asking before quitting application - ~#78, #90 bug: saving files (sometimes?) does not work~ → !92 fix: allow repeated saving to same file path </details> <details><summary><h4>Maintenance</h4></summary> - [x] Evidence of recent development activity - [x] Confidence in the maintainers' ability to reliably maintain the project - [x] Being careful about inflicting harm like data loss on users - [x] Keeping up with maintenance to at least using a supported runtime on Flathub </details> <details><summary><h4>Technology Basis</h4></summary> - [x] Uses GTK 4 + Libadwaita - [x] Uses the GNOME runtime on Flathub </details> <details><summary><h4>Design</h4></summary> - [x] Follows the [Human Interface Guidelines](https://developer.gnome.org/hig/) - [x] Dark mode works - [x] Contrast is maintained everywhere (no dark font color on dark background etc.) - [x] No white surfaces (apart from external media etc) </details> <details><summary><h4>Content</h4></summary> - [x] Does not contradict the intentions of the [GNOME Code of Conduct](https://conduct.gnome.org/) - [x] Does not promote cryptocurrencies or related services </details> <details><summary><h4>Legal</h4></summary> - [x] Has an [OSI-approved license](https://opensource.org/licenses) - [x] No contributor license agreement (CLA) - [x] The software must work without installing proprietary software </details> <details><summary><h4>Metadata</h4></summary> - [x] App metainfo is valid (`appstreamcli validate ./path/to/<app-id>.metainfo.xml` passes) - [x] App name follows [guidelines](https://developer.gnome.org/hig/guidelines/app-naming.html) - [x] App icon follows [guidelines](https://developer.gnome.org/hig/guidelines/app-icons.html) - [x] Screenshot quality ([more info](https://gitlab.gnome.org/GNOME/Initiatives/-/wikis/Update-App-Screenshots)) - [x] "Summary" quality ([more info](https://gitlab.gnome.org/GNOME/Initiatives/-/wikis/App-Metadata#summary)) - [x] .doap-file in repository exists and is up-to-date ([more info](https://gitlab.gnome.org/World/apps-for-gnome/-/blob/main/METADATA.md#doap)) - → !48 chore: add doap file - → !54 ... rename doap file - [x] Hardware support information [is present](https://gitlab.gnome.org/GNOME/gnome-software/-/wikis/Software-metadata#how-to-add-missing-hardware-information) - → !27 chore: adjust Appstream meta data - [x] Content rating information [is present](https://gitlab.gnome.org/GNOME/gnome-software/-/wikis/Software-metadata#how-to-add-missing-content-rating-information) </details> <details open><summary><h4>Accessibility</h4></summary> - [x] Can navigate to all elements via keyboard and use them - [x] Uses standard keyboard shortcuts ([more info](https://developer.gnome.org/hig/reference/keyboard.html)) - [x] High-contrast mode works - [x] Large text mode works - [x] Sufficient contrast between content and background - [ ] Works with Orca (activate via `Alt+Super+S`) - [x] Image buttons have a tooltip </details> <details open><summary><h4>Repository</h4></summary> - [x] Passing CI builds of the app - → !82 chore(ci): add automated flatpak builds on GNOME Gitlab for pull requests - [x] Public issue tracker and code repository - *The repository does *not* need to be hosted on GNOME's GitLab instance.* - [ ] Making contributors aware that the [GNOME Code of Conduct](https://conduct.gnome.org/) applies to the project - *For example linking to the Code of Conduct in the project's README* </details> <details><summary><h3>Recommended General App Criteria</h3></summary> - [x] Builds Flatpak in Builder out of the box - [x] Build system is Meson, Automake, or CMake </details> <details><summary><h3>Circle App Criteria</h3></summary> - [x] Available on Flathub - [x] Available for x86\_64 and aarch64 - ~#6 meta: publish on flathub for easier installation and discoverability~ - [x] No GNOME branding - *The app may not use GNOME in its name or its author field and may not promote the app as official GNOME software. However, after inclusion into GNOME Circle, the maintainers are encouraged to promote the app as being part of "GNOME Circle", using [the Circle branding](https://gitlab.gnome.org/Teams/Circle/-/tree/main/assets/button).* - [x] App ID is valid - Valid app IDs are - IDs of the form `<public-suffix>.<something>.<app>`, where `https://<something>.<public-suffix>/.well-known/org.flathub.VerifiedApps.txt` can be controlled by the user - IDs of the form `com.github.<user>.<app>`, `io.github.<user>.<app>`, `com.gitlab.<user>.<app>`, or `io.gitlab.<user>.<app>`. - IDs that are on the [list of legacy apps](https://gitlab.gnome.org/Teams/Releng/AppOrganization/-/blob/main/data/registered-app-ids.yml) - Invalid app IDs - Does not have the form `org.gnome.<app>`, expect the cases listed in the valid app IDs above - Follows [Flatpak requirements](https://docs.flatpak.org/en/latest/conventions.html#application-ids) like replacing `-` with `_` in app IDs - [x] The app support internationalization and is connected to some localization infrastructure. </details> <details><summary><h3>Additional criteria (not from GNOME's list)</h3></summary> - [x] Description of `<releases>` in metadata for stable releases, see [here](https://www.freedesktop.org/software/appstream/docs/sect-Metadata-Releases.html) and [here](https://discourse.gnome.org/t/if-your-app-contains-appstream-metadata-file-eg-org-gnome-x-appdata-xml/16373). </details> ## GNOME Circle application submission https://gitlab.gnome.org/Teams/Circle/-/issues/264 <details><summary> ### 1. Review ([Tobias Bernard](https://gitlab.gnome.org/Teams/Circle/-/issues/264#note_2661013))</summary> Hi, thanks for your interest in Circle! Not a proper review yet, but a few initial things I came across: - [x] There seems to be no zoom/pan (except after resizing the window), which is really needed for an app like this. I'd look at Loupe as an example for how to do this well behavior-wise with various types of input. - ~#107 feat: improve zoom accessibility~ → !177 feat: add pinch to zoom and improve zooming behaviour - [x] The non-flat "Save As" button on the top left is a bit odd, I'd use a more standard pattern here with "Open" in the top left and "Save" somewhere on the right, both with an icon - → !127 feat: improve user interface by moving buttons around, !130 feat: improve saving experience - [x] Would be good to set a custom cursor that makes it obvious you're about to draw rectangles - → !105 feat: use crosshair cursor for rectangle selection </details> <details><summary> ### 2. Review ([Martin Abente Lahaye](https://gitlab.gnome.org/Teams/Circle/-/issues/264#note_2663314))</summary> > not sure, how much CI is required here: CI for building? - [x] Yeah, making sure it's building fine would be enough. - → !82 chore(ci): add automated flatpak builds on GNOME Gitlab for pull requests </details> <details open><summary> ### 3. Review ([Tobias Bernard](https://gitlab.gnome.org/Teams/Circle/-/issues/264#note_2732579))</summary> Thanks for the updates! Here are a few more things I found testing the latest version: - [ ] This should use a more standard empty state with a title and subtitle, and a pill button instead of the headerbar open button. I'd look at Papers as an example. <details><summary>Screenshots</summary> Censor|Papers ---|--- | </details> - [ ] Would it be possible to navigate all pages in a single scrollview, like in Papers? The page-wise navigation is a bit cumbersome. If this is technically not possible I'd at least look into adding some more ergonomic pager buttons, maybe as an overlay in the bottom left like in Loupe. - #10 feat: continuous page view <details><summary>Screenshot</summary>  </details> A few papercuts with the zoom functionality: - [ ] Zoom via Ctrl+Scroll is too slow/sensitive, I'd copy the behavior from Loupe or Papers here - [ ] I'd be good to add panning with the middle mouse button,like in other similar apps - [ ] Pinch to zoom behaves weirdly, it seems as though it doesn't actually zoom into where the cursor is? Here, too, I'd look at Loupe or Papers for the exact behavior. - [ ] Zoom needs some UI controls, either in the primary menu (like in Web) or as an overlay (like in Loupe) </details>

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor

censor/Censor