Improve onboarding documentation #1723
Assignees
Labels
bug
End user-perceivable behaviors which are not desirable.
Impact: Medium
Moderate perceived user impact (non-blocking bugs and general improvements).
Issue: Needs Break-down
Indicates that an issue is too large and should be broken into smaller chunks.
Work: High
It's not clear what the solution is.
Z-ibt
Temporary label for Ben to keep track of issues he's triaged.
Comments
BenHenning
added
Type: Documentation
Priority: Essential
|
Reaffirming the need especially for clear instructions on how to run tests. |
|
I would like to work on this! |
|
@UvrajSB I think that this issue might need some revising before it can be divided up. @MaskedCarrot do we have a more updated list for documentation work items? |
|
@BenHenning The dev-workflow team has a documentation tracker that contains wiki pages and their progress. |
|
@MaskedCarrot are all of the above accounted for in the tracker (and, if not, should they be?)? It'd be nice to have a single source of truth so that we don't have potential confusion around where to look for things. That being said, there probably ought to be a tracking issue on GitHub for the work (even if it just points to the tracker). Does one exist? |
|
@BenHenning No, not all of them are in the tracker. I will discuss this with the welfare and the dev-workflow teams and file issues for all the wiki pages that need to be updated. |
Thanks @MaskedCarrot! Can you update this task once that's completed? (Either by linking to the new issues & tracker and closing this, or by updating it and mentioning that it's the source of truth for changes). |
@UvrajSB You should work with your onboarding mentor to find technical work to do. Documentation can be really difficult to write if you don't have the needed technical context for the project, so I suggest submitting a few PRs before working on documentation changes (however, once the PRs are merged, you can reach out to @MaskedCarrot to see what's available). |
Broppia
added
issue_type_infrastructure
Impact: Low
seanlip
added
bug
|
@MohitGupta121 PTAL. Not all of the checkboxes are easy to handle but let's at least track the ones that are easy, and check those off here once they're done. Thanks! |
|
@seanlip Thanks Sean, this really helps to track. |
|
Also as a follow-up, these ought to be entirely focused on Bazel at this point @MohitGupta121 since there's not much value in writing out Gradle-based instructions with the plan to remove Gradle in the next 1-2 months. |
|
@BenHenning Yes I keep the Bazel thing in mind, but First I think we need to go with installation and setup of Bazel, then we move to other flow and documents. |
|
@BenHenning If possible, Can you please update the Issue description Points that we need step by step work on. |
|
Yep completely agree @MohitGupta121. |
Sorry not sure what this means--could you clarify what needs to be updated? |
I talking about the issue task list, I think we need to update the description task list. It's was not seems out of dated? |
|
I think all of the tasks listed are worthwhile @MohitGupta121, but if any are fully or partially completed, feel free to edit the main comment & link to the corresponding wiki pages (and tick off items if they're completed). |
|
Okay Thanks @BenHenning, I will follow these instructions. |
MohitGupta121
moved this from Todo
to In Progress
in [Team] Developer Workflow & Infrastructure - Android
seanlip
removed
the
Priority: Essential
MohitGupta121
moved this from In Progress
to Todo
in [Team] Developer Workflow & Infrastructure - Android
6 tasks
adhiamboperes
added a commit
that referenced
this issue
Oct 9, 2023
…ntation (#5174) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> ## Explanation Fix #5073: Add instructions to the wiki for how to assign a reviewer. Fix #5062: Add wiki documentation for how to pick the emulator/android version when running Espresso tests. Fix #5099: Reorganize the Project Setup Documentation Fix part of #1723: ensure the onboarding flow leads into follow-up documentation: architecture overview, code style, submission guidelines, how to make UX changes, how to contribute large projects (which should tie into design documents), and best practices Fix part of #1723: Known issues that have come up in discussions ## Essential Checklist <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".) - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).
6 tasks
adhiamboperes
pushed a commit
that referenced
this issue
Oct 31, 2023
…ributors (#5210) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> ## Explanation Fix #5214 : Wiki link not redirect to correct destination ( good-first-issue link) Fix Part of #1723 : Fix onboarding issue faced by new contributors. 1. Tell contributors firmly to use "Android Studio Bumblebee | 2021.1.1 Patch 3." 2. In the wiki, make sure to mention that you need to have JDK 11 to use oppia-android. 3. Concentrate on using robolectric instead of espresso and provide clear instructions for setting up tests. <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> ## Essential Checklist <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".) - [ ] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).
adhiamboperes
added a commit
that referenced
this issue
Jan 11, 2024
Refactor firebase auth wrapper Refactor dagger bindings for firestore dependencies Ensure firestore logs show in dev event logs view. Removed redundant bindings. Localisation updates from https://translatewiki.net. (#5209) Translation updates Fixes #4708: Don't submit answer if it's invalid according to the input (#5205) Fixes #4708: Don't submit answer if it's invalid according to the input or else after submitting the recycler view will not restore items on configuration change. See #4708 for more details Video demo: [before](https://drive.google.com/file/d/1bLgo-AYro0UbffR6X8nWo8Xv7oUuNJFa/view?usp=sharing) [after](https://drive.google.com/file/d/1Oek7j6dgjJmgasyyd9FHtQo4E7zTvEBd/view?usp=sharing) Continuation of PR #5202 since that one's no longer viable due to being force pushed in a repo sync through GitHub UI. - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [ ] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing Change unrelated to concerns like dark mode, RTL, accessibility. PR demonstration of tests passing. --------- Co-authored-by: Long Wei <[email protected]> Co-authored-by: Adhiambo Peres <[email protected]> Fix part of #5195: using viewLifecycleOwner (#5207) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> It is not a good idea to use a fragment as a lifecycle owner when subscribing to liveData objects. It would be correct to use viewLifecycleOwner. Lint report before: <img src="https://github.com/oppia/oppia-android/assets/71126152/ad482fd4-d3b0-46c7-b7de-febe7a48c07b" width="70%" height="70%" /> Lint report after <img src="https://github.com/oppia/oppia-android/assets/71126152/fe7a26cf-1fcd-4cd5-ae3a-3cb7dcf2659c" width="70%" height="70%" /> <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing Fix #5032 Images in Arabic (RTL) lessons are right-aligned rather than center-aligned. (#5212) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> Fixes #5032, To make the image center-aligned, we are adding styling to the HTML content image and removing the left margin by setting drawableLeft bound to 0 in RTL. <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [ ] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). LTR Potrait  LTR Landscape  RTL Potrait  RTL Landscape  RTL Potrait  RTL Landscape  LTR Potrait  LTR Landscape  <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing fix: Fix Translate Wiki Issues with Splash Activity Screen Strings (#5219) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> When merged, this PR will: - Remove white spaces and new lines that were added to Splash Activity Screen strings by the [App/OS Deprecation Milestone 3 PR](#5096). This will allow TranslateWiki to translate them. See related [comment on the PR](d471d79#r130759117). <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing Co-authored-by: Adhiambo Peres <[email protected]> Fix #5214, Fix Part of #1723 : Fix onboarding issue faced by new contributors (#5210) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> Fix #5214 : Wiki link not redirect to correct destination ( good-first-issue link) Fix Part of #1723 : Fix onboarding issue faced by new contributors. 1. Tell contributors firmly to use "Android Studio Bumblebee | 2021.1.1 Patch 3." 2. In the wiki, make sure to mention that you need to have JDK 11 to use oppia-android. 3. Concentrate on using robolectric instead of espresso and provide clear instructions for setting up tests. <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [ ] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). Fix #5204 - Inconsistent Layout Lint Warning (#5218) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> Fix #5204 - [Part of #5169] To address the lint warnings, two potential solutions were considered. 1. Initially, there was an option to include the missing IDs, ensuring consistency across different layout configurations [[**Link**](Rd4dev@f8977e6)]. However, it was observed that implementing this solution led to functional disruptions within the current working application, as confirmed through comprehensive testing procedures (refer to the attached assets for a detailed overview). https://github.com/oppia/oppia-android/assets/122200035/82172eaf-a555-4e76-b1ae-8f0db7ddb924 2. The second option was to suppress the lint warnings for the specific views in the layout-sw600dp configuration files [[**Link**](Rd4dev@a0f5b1e)] to maintain the seamless functionality of the application . This was achieved by incorporating the attribute **`tools:ignore="InconsistentLayout"`** for relevant views, without impacting the current operational stability of the application. https://github.com/oppia/oppia-android/assets/122200035/93a65422-3526-4d76-873f-c08d24abc3ee Taking the necessary action, I proceeded to implement the suppression of lint warnings by submitting a pull request. <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [ ] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing Co-authored-by: Adhiambo Peres <[email protected]> Fix #5112: Rendering Inline SVGs (#5208) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> Fixes #5112 We discovered that `mathImg_` dimesions are in **ex**, and not **px**, and this unit is not natively rendered on android. This PR introduces a method that will convert ex to px and use the resulting dimesions to compute the rendering size of a math image to be rendered inline. The formula is based on the [androidSvg library](https://github.com/oppia/androidsvg/blob/5bc9c7553e94c3476e8ea32baea3c77567228fcd/androidsvg/src/main/java/com/caverock/androidsvg/androidrendering/SVGAndroidRenderer.java#L5018) that is also based on CSS3 specs. To preserve the size computation of block SVGs, we have created a seperate method that handles the calculation of rendering dimensions for inline SVGs. We have only tested these changes through visual observation, and confirming that the images scale correctly when reading text size is changed. <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). |Before|After| |--|--| ||| ||| ||| ||| ||| Images scaled to Largest text and display size, and dark mode |||| |--|--|--| |||| |||| --------- Co-authored-by: Ben Henning <[email protected]> Fix #3596: Adds Audio Loading UI (#5179) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> Fixes #3596 This PR adds an indeterminate progress bar when the audio is loading, before it starts playing. <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing https://github.com/oppia/oppia-android/assets/84731134/5c6fe393-5d89-4bda-a144-57bdc42a9c57 --------- Co-authored-by: Adhiambo Peres <[email protected]> Fix #5226: EnableContinueButtonAnimation Feature Flag (#5228) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> Fix #5226 Remove declarations and usages of the enableContinueButtonAnimation PlatformParameter. (A) Removed declaration of TestPlatformParameterModule.forceEnableContinueButtonAnimation() from all test functions namely: testContinueInteractionAnim_openPrototypeExp_checkContinueButtonAnimatesAfter45Seconds(), testConIntAnim_openProtExp_orientLandscapeAfter30Sec_checkAnimHasNotStarted(), testConIntAnim_openProtExp_orientLandAfter30Sec_checkAnimStartsIn15SecAfterOrientChange(), testContNavBtnAnim_openMathExp_checkContNavBtnAnimatesAfter45Seconds(), testContNavBtnAnim_openMathExp_playThroughSecondState_checkContBtnDoesNotAnimateAfter45Sec(), testConIntAnim_openFractions_expId1_checkButtonDoesNotAnimate() in StateFragmentLocalTest.kt file (B) Removed function declaration TestPlatformParameterModule.forceEnableContinueButtonAnimation(false) from setup() function in StateFragmentTest.kt (C) Removed function declaration TestPlatformParameterModule.forceEnableContinueButtonAnimation(false) from setup() function in ExploreActivityTest.kt <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). Fix #5230: VectorDrawableCompat error lint (#5237) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> Fix #5230: VectorDrawableCompat Lint error Warning: VectorDrawableCompat Fix: opened the app's build.gradle file. Inside the android block, added the vectorDrawables section under defaultConfig with the code below: android { ... defaultConfig { ... vectorDrawables { useSupportLibrary true } } } <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). Fix #3345 Images are not fully displayed (#5234) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> Fixes #3345, substracting drawableWidth from maxContentItemPadding only if drawableWidth >= (maxcontentWidth - maxContentItemPadding) would solve the issue. <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). https://user-images.githubusercontent.com/82181327/122643554-54f1ac00-d108-11eb-906f-6748d2facf2f.jpg https://user-images.githubusercontent.com/101634267/245153650-cd8335df-01ec-47e6-97b2-7f7244d95efb.jpg https://user-images.githubusercontent.com/101634267/245153665-cb9506d2-6d0d-4231-8a42-5f8ab15cf4d4.jpg      <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing Localisation updates from https://translatewiki.net. (#5242) Translation updates Fix #5137: Upgrade builds to target SDK 33 (#5222) Fixes #5137 Partially mitigates #5233 This updates all build & target SDKs for Gradle & Bazel builds to now target SDK 33, per the new Play Store mandate (see https://support.google.com/googleplay/android-developer/answer/11926878?hl=en). The analysis of SDK 33 features, potential issues, and potential mitigations are described in #5137. It was determined that there are no obvious code changes needed beyond the minimum to target SDK 33. We'll be relying on some platform-level regression testing plus the Play Console's pre-submit app analysis report for finalizing the go/no-go decision for SDK 33 support. Testing consisted of manually playing through the app and seeing if there were any issues using emulators both with SDK 33 and lower versions. #5137 documents the issues found and their ultimate causes. Since no functionality changes were needed for SDK 33, no tests needed updating. Separately, tests are still running on SDK 30 due to being stuck (see #4748). One issue unrelated to SDK 33 was observed: when playing through the prototype lesson, I once again brought the app into a broken state wherein I couldn't leave the lesson via navigation. We've hit this issue a few times, but still don't know the root cause. #5233 was filed and a mitigation was introduced in this PR (+ a test for it): if the exploration player observes a failure when trying to stop the player session (for whatever reason), it still proceeds with its "end of activity" flow (e.g. finishing the activity). This provides at least an escape hatch for users who somehow hit this state. Note that this isn't a proper fix for #5233 given the lack of a known root cause, so this is only considered a mitigation. The new test was verified as failing if the mitigation is omitted:  Note that ``ExplorationActivityTest``'s setup was tweaked to change the parent screen since this affects back navigation routing. I opted to using lessons tab as the parent screen since it's the most common route for users to hit, so it makes sense for our tests to default to that if they don't specifically need to use a different route (and none of the existing tests seemed to have an issue with this change). - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). N/A -- This isn't changing any UIs directly, and per the analysis in 33 that would affect Oppia. Technical Analytics: Milestone 1 - Add Feature Flag Statuses and Ability To Sync Them to Cache Store (#5203) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> When merged, this PR will: - Create a new `FeatureFlagConstants.kt` file to contain all feature flags. - Create feature flag sync status trackers for each existing feature flag. - Modify the `PlatformParameterSyncUpWorker` to allow status trackers of all feature flags to be synced and cached in the PersistentCacheStore. - Merge the `TestBooleanPlatformParameter`, `TestStringPlatformParameter` and the `TestIntegerPlatformParameter` files into the `TestPlatformParameterConstants` file. - Add syncing with the web for the `EnableDownloadsSupport`, `EnableEditAccountsOptionsUi`, `EnableSpotlightUi`, `EnableExtraTopicTabsUi`, `EnableInteractionConfigChangeStateRetention`, and `EnableAppAndOsDeprecation` feature flags. - Write tests for the changes made. <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing --------- Co-authored-by: Adhiambo Peres <[email protected]> Co-authored-by: Ben Henning <[email protected]> Refactor TestAuthenticationModule.kt to provide FirebaseAuthWrapper Ensure firestore logs show in dev event logs view. Removed redundant bindings. Remove FakeAuthenticationController and refactored its usages to the new FakeFirebaseWrapperImpl Remove DebugFirestoreEventLogger.kt and usages. Update AuthenticationControllerTest tests Fix static analysis checks Fix bazel build errors Reformat auth/BUILD.bazel Create wrapper for firebase auth instance Fix lint errors Fix failing tests Fix failing lint checks Fix test failures Fix BUILD file formatting Fix DebugFirestoreEventLoggerImplTest Fake a firebase instance. Fix build failures Fix test file exemption warnings Fix bazel build input file Fix bazel build input file Fix failing tests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The current onboarding documentation is a bit thin, and may not be super easy to follow. The following improvements should be made:
The text was updated successfully, but these errors were encountered: