Skip to content
New issue

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

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

Already on GitHub? # to your account

Android Gradle Plugin and Gradle Locks bump #1508

Merged
merged 4 commits into from
Jul 1, 2024

Conversation

Milan-Cerovsky
Copy link
Contributor

@Milan-Cerovsky Milan-Cerovsky commented Jun 25, 2024

Note
This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review your own code in GitHub's web interface1
  • Add automated tests as appropriate
  • Update the manual tests2 as appropriate
  • Check the code coverage3 report for the automated tests
  • Update documentation as appropriate (e.g README.md, Architecture.md, etc.)
  • Run the demo app and try the changes
  • Pull in the latest changes from the main branch and squash your commits before assigning a reviewer4

Reviewer

  • Check the code with the Code Review Guidelines checklist
  • Perform an ad hoc review5
  • Review the automated tests
  • Review the manual tests
  • Review the documentation, README.md, Architecture.md, etc. as appropriate
  • Run the demo app and try the changes6

Footnotes

  1. Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.

  2. While we aim for automated testing of the SDK, some aspects require manual testing. If you had to manually test
    something during development of this pull request, write those steps down.

  3. While we are not looking for perfect coverage, the tool can point out potential cases that have been missed. Code coverage can be generated with: ./gradlew check for Kotlin modules and ./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true for Android modules.

  4. Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

  5. In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.

  6. While the CI server runs the demo app to look for build failures or crashes, humans running the demo app are
    more likely to notice unexpected log messages, UI inconsistencies, or bad output data. Perform this step last, after verifying the code changes are safe to run locally.

@Milan-Cerovsky Milan-Cerovsky requested a review from HonzaR June 25, 2024 10:48
@Milan-Cerovsky Milan-Cerovsky self-assigned this Jun 25, 2024
Milan Cerovsky and others added 2 commits June 26, 2024 11:58
@HonzaR HonzaR force-pushed the gradle-dependencies-bump branch from 5b80538 to 2c03c30 Compare June 28, 2024 14:29
Copy link
Contributor

@HonzaR HonzaR left a comment

Choose a reason for hiding this comment

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

I just updated .gitignore to remove the .idea/.name file. It would also be good to file the same issue we filed in the Zashi project: Electric-Coin-Company/zashi-android#1495. Thank you for the update.

docs/Setup.md Show resolved Hide resolved
@Milan-Cerovsky Milan-Cerovsky merged commit dee3874 into main Jul 1, 2024
11 of 12 checks passed
@Milan-Cerovsky Milan-Cerovsky deleted the gradle-dependencies-bump branch July 1, 2024 11:39
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants