Merge pull request #4013 from vector-im/feature/bma/a11y_guidelines

Update pull request checklist

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,16 @@
 ### Pull Request Checklist
 
-<!-- Please read [CONTRIBUTING.md](https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md) before submitting your pull request -->
+<!--
+ Please read [CONTRIBUTING.md](https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md) before submitting your pull request
+ Depending on the Pull Request content, it can be acceptable if some of the following checkboxes stay unchecked.
+ -->
 
 - [ ] Changes has been tested on an Android device or Android emulator with API 21
 - [ ] UI change has been tested on both light and dark themes
+- [ ] Accessibility has been taken into account. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#accessibility
 - [ ] Pull request is based on the develop branch
 - [ ] Pull request includes a new file under ./changelog.d. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog
 - [ ] Pull request includes screenshots or videos if containing UI changes
 - [ ] Pull request includes a [sign off](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#sign-off)
+- [ ] You've made a self review of your PR
+- [ ] If you have modified the screen flow, or added new screens to the application, you have updated the test [UiAllScreensSanityTest.allScreensTest()](https://github.com/vector-im/element-android/blob/main/vector/src/androidTest/java/im/vector/app/ui/UiAllScreensSanityTest.kt#L73)

CONTRIBUTING.md

@@ -148,6 +148,8 @@ The string will be removed during the next sync with Weblate.
 
 Please consider accessibility as an important point. As a minimum requirement, in layout XML files please use attributes such as `android:contentDescription` and `android:importantForAccessibility`, and test with a screen reader if it's working well. You can add new string resources, dedicated to accessibility, in this case, please prefix theirs id with `a11y_`.
 
+For instance, when updating the image `src` of an ImageView, please also consider updating its `contentDescription`. A good example is a play pause button.
+
 ### Layout
 
 When adding or editing layouts, make sure the layout will render correctly if device uses a RTL (Right To Left) language.

vector/lint.xml

@@ -21,12 +21,12 @@
     <!-- Accessibility -->
     <issue id="LabelFor" severity="error" />
     <issue id="ContentDescription" severity="error" />
+    <issue id="SpUsage" severity="error" />
 
     <!-- Layout -->
     <issue id="UnknownIdInLayout" severity="error" />
     <issue id="StringFormatCount" severity="error" />
     <issue id="HardcodedText" severity="error" />
-    <issue id="SpUsage" severity="error" />
     <issue id="ObsoleteLayoutParam" severity="error" />
     <issue id="InefficientWeight" severity="error" />
     <issue id="DisableBaselineAlignment" severity="error" />