-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Detekt - Resolve/Suppress All Baseline Warnings - Long methods warnings_ MediaPickerFragment #17376
Conversation
👋🏾 @ParaskP7 here we go again 😎 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👋 @Hoossayn !
Thank you so much for this PR. One contribution a day keeps the doctor away, right, or was that for apples?! 🎉
I reviewed and tested this PR as per the description, along with triggering CI on it via a draft PR, which I just pushed on the main repo.
As promised, and per your contribution, I'll keep guiding you with additional notes so that you could demonstrate your best work. So, here goes once more:
- PR Description Related:
- Main
- You wrote:
This PR resolved/suppress all complexity related LongMethod warnings for the WordPress module (see docs):
- I recommend:
This PR resolves/suppresses all complexity related LongMethod warnings for the MediaPickerFragment class (see docs):
- Did you note the differences? It is important to have a description that matches your work and that what you are writing is grammatically correct.
- You wrote:
- Sections
- Adding
-----
will split the sections with a horizontal line, maybe you could have utilized this markdown and split theTo test:
section.
- Adding
- Testing Instructions
- Who wrote:
However, if you really want to be thorough, you could smoke test the WordPress and/or Jetpack apps to verify that everything works as expected on every screen that relates to these changes.
- I recommend:
However, if you really want to be thorough, you could smoke test the WordPress and/or Jetpack apps to verify that everything works as expected on every screen that relates to these changes. Specifically, you could follow the below steps:
- Then, you could remove the
STEPS
and also have theGo to the menu tab
and other related instructions on a second level indentation (just like I do with my suggestions to you here).
- Who wrote:
- Main
- Commit Related:
- Branch Name:
- Your naming:
17010_Detekt_Resolve_Suppress_All_Baseline_Warnings_long_method_MediaPickerFragment
- I recommend:
issue/17010-media-picker-fragment-detekt-baseline-warnings
- Did you note the differences? For example, you will notice the
issue
folder level, then followed by the issue id, all words are lowercases and split with a dash (-
) character instead of an underscore (_
) character. FYI: This is the patter all our engineers are using, thus it would be great if you did the same, for consistency purposes.
- Your naming:
- I noticed that on some of your commit messages you are adding the extra space (
- Branch Name:
All the above are tips for next time so don't be too alarmed, that is, you don't need to be doing anything on them for this PR, you could just update the PR description if you like.
However, I have a couple of additional minor (🔍) and suggestions (💡) comments for you. Please take a look at them and let me known what you think. I'll then approve this PR straight away and merge this to trunk
. 💯
WordPress/src/main/java/org/wordpress/android/ui/mediapicker/MediaPickerFragment.kt
Outdated
Show resolved
Hide resolved
👋🏾 @ParaskP7, one commit a day keeps the bugs away 🥳 , followed your suggestions and made changes to the code/doc 🙌🏾 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👋 @Hoossayn !
Thank you so much for applying my suggestions! 🙇 💯 🥇
I did another review on your changes and everything looks good to me. As soon as CI goes ✅ I'll merge this to trunk
.
Just a quick FYI:
- Yours:
This PR resolved/suppress all complexity related LongMethod warnings for the MediaPickerFragment class (see docs here):
- Mine:
This PR resolves/suppresses all complexity related LongMethod warnings for the MediaPickerFragment class (see docs here):
- Find the diff! 😅
@ParaskP7 shame on me 😭😂 |
Parent: #17010
This PR resolves/suppresses all complexity related LongMethod warnings for the MediaPickerFragment class (see docs here):
1
x LongMethod and1
x ComplexMethod (Resolve: 9bbd91e + 37c9fa5 + eed436e)To test:
There is nothing much to test here.
Verifying that all the CI checks are successful should be enough (especially the detekt check).
However, if you really want to be thorough, you could smoke test the WordPress and/or Jetpack apps to verify that everything works as expected on every screen that relates to these changes. Specifically, you could follow the below steps:
Regression Notes
Potential unintended areas of impact
can't think of any
What I did to test those areas of impact (or what existing automated tests I relied on)
See
To test
section above.What automated tests I added (or what prevented me from doing so)
N/A
PR submission checklist:
RELEASE-NOTES.txt
if necessary.