Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #5246: "Update the Android FAQ" #5247

Merged
merged 30 commits into from
Dec 1, 2023

Conversation

deonwaju
Copy link
Collaborator

@deonwaju deonwaju commented Nov 28, 2023

Explanation

Fixes #5246: "Update the Android FAQ"

  1. Changed the order in which the FAQ questions where arranged by refactoring the property name of each string to the appropriate one based on requirements from [Feature Request]: Update the Android FAQ #5246.
  2. Added new questions based on requirements from [Feature Request]: Update the Android FAQ #5246.
  3. Refactored the faq question property names in the tests written in FAQListFragmentTest.kt according to the new order in which the questions where arranged.
  4. Created a string extension file in string extensions to check if string resource contains a placeholder, to be able to dynamically replace the placeholders with the appropriate string values.
  5. Used the string extension to check if any string resource file from the FAQ questions and answers contains a placeholder, then call function to replace placeholder with appropriate string value.
WhatsApp.Video.2023-12-01.at.09.30.07.mp4
WhatsApp.Video.2023-12-01.at.09.30.17.mp4

Essential Checklist

  • 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 files have their rationale included in the PR explanation.
  • The PR follows the style guide.
  • The PR does not contain any unnecessary code changes from Android Studio (reference).
  • 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).

@deonwaju deonwaju requested a review from a team as a code owner November 28, 2023 00:31
@deonwaju
Copy link
Collaborator Author

@adhiamboperes PTAL

@deonwaju
Copy link
Collaborator Author

Hello @adhiamboperes , I want to push this pr as a collaborator but when i cloned i still dont have permission to push my branch

@deonwaju
Copy link
Collaborator Author

deonwaju commented Nov 28, 2023

Hello @adhiamboperes , I want to push this pr as a collaborator but when i cloned i still dont have permission to push my branch

Sorry, I don't understand your question. Could you please clarify what you mean push as a collaborator? Did you re-clone the repo?

Yes i did re-clone the repo, The error is a permission error, I mean i want to push this PR after i clone the original project and not from this forked repo.

@adhiamboperes
Copy link
Collaborator

Hello @adhiamboperes , I want to push this pr as a collaborator but when i cloned i still dont have permission to push my branch

Sorry, I don't understand your question. Could you please clarify what you mean push as a collaborator? Did you re-clone the repo?

Yes i did re-clone the repo, The error is a permission error, I mean i want to push this PR after i clone the original project and not from this forked repo.

You still need to work on your fork.

@deonwaju
Copy link
Collaborator Author

deonwaju commented Nov 28, 2023

Hello @adhiamboperes , I want to push this pr as a collaborator but when i cloned i still dont have permission to push my branch

Sorry, I don't understand your question. Could you please clarify what you mean push as a collaborator? Did you re-clone the repo?

Yes i did re-clone the repo, The error is a permission error, I mean i want to push this PR after i clone the original project and not from this forked repo.

You still need to work on your fork.

Alright, thanks just clarifying, thought addition to the codebase meant working from within the codebase. I am done with the PR, the last CI that didnt pass is a REGEX error for the word Oppia.

Screenshot 2023-11-29 at 00 47 13

I could solve it by using a placeholder %s but I would mess with the logic below @adhiamboperes

Screenshot 2023-11-29 at 00 51 01

@adhiamboperes
Copy link
Collaborator

@deonwaju, that particular code is quite brittle, and it would be great if you updated it to support the new required behaviour. We now have two questions/answers with the word Oppia, and more could be added in the future. Also, the indices could change any time, as they have now.

@deonwaju
Copy link
Collaborator Author

@adhiamboperes PTAL

@oppiabot oppiabot bot assigned adhiamboperes and unassigned deonwaju Nov 30, 2023
Copy link

oppiabot bot commented Nov 30, 2023

Unassigning @deonwaju since a re-review was requested. @deonwaju, please make sure you have addressed all review comments. Thanks!

Copy link
Collaborator

@adhiamboperes adhiamboperes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @deonwaju, this LGTM.

What's left here is to add a screen recording to your PR description to make it easy to verify that the questions are indeed in the new expected order.

Also kindly just add a brief explantion of the changes made in this PR(the why and how) based on the issue description.

@oppiabot oppiabot bot added the PR: LGTM label Dec 1, 2023
Copy link

oppiabot bot commented Dec 1, 2023

Hi @deonwaju, this PR is ready to be merged. Please address any remaining comments prior to merging, and feel free to ask someone to merge your PR once the CI checks pass and you're happy with it. Thanks!

@deonwaju
Copy link
Collaborator Author

deonwaju commented Dec 1, 2023

@adhiamboperes PTAL

@oppiabot oppiabot bot assigned adhiamboperes and unassigned deonwaju Dec 1, 2023
Copy link

oppiabot bot commented Dec 1, 2023

Unassigning @deonwaju since a re-review was requested. @deonwaju, please make sure you have addressed all review comments. Thanks!

@adhiamboperes
Copy link
Collaborator

Thanks @deonwaju. This looks great!

@adhiamboperes adhiamboperes merged commit 176b268 into oppia:develop Dec 1, 2023
40 checks passed
@deonwaju deonwaju deleted the feature/update_faq branch December 7, 2023 09:57
adhiamboperes added a commit that referenced this pull request Feb 14, 2024
<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->
## Explanation
<!--
- 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 #4527

The [design team](oppia/design-team#75) and
the previous [PRs](#5247)
addressed various issues and revised the FAQ list. However, @seanlip
pointed out in the
[discussions](oppia/design-team#75 (comment))
that the FAQ related to updating mobile numbers or email addresses
appears inappropriate.

After verifying with @adhiamboperes and @BenHenning, the initial commit
includes removing [that specific
FAQ](https://github.com/oppia/oppia-android/blob/3ced7e14a8bff8c3757ed15a1626b0e63c6ce14d/app/src/main/res/values/strings.xml#L574)

## 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)).

---------

Co-authored-by: Adhiambo Peres <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Update the Android FAQ
2 participants