Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Reviewer Checklist

Jump to bottom
Application Library Engineering Group edited this page Jul 14, 2021 · 6 revisions

Review Checklist

Topic Description Identification method Issue check
Code Structure Here there are 2 parts :-
1. Code structure for library and application as per openHarmony guidelines.
2. Imported library structure		 A base template for application and library can be created based on the latest IDE and SDK and compare the params based on this Make sure we are following the latest config.json information for the project, this is help reduce the runtime issues.
SDK and tool chain Always use the latest SDK and buildtools for development Build.config will have this information about the hap classpath and the sdk version used.
Static tool report Currently we will follow
1. Checkstyle, spotbugs
2. Later we will migrate to Sonar or other industry level tool		 1. All critical and major issues should be handled.
2. Minor and info to be discussed and handled.
Gradle changes Make sure there are no dependencies added which are not used by the library or application Check build.gradle in project and module folders
Test folders UT is a mandatory requirement, but if there is any reason after approval UT cases are not done, make sure dead folders are not there in project Check the test folders in library and sample application
Copyright 1. For the new files we add applib group copy right.
2. For the modified files we will retain the existing copy right.
3. In case modified files don't have copy right existing, then keep it like that. Keep the status quo.		 Compare the files from original library and follow this rule New copyright will be shared and added here
License 1. For the new files, Apache 2.0 license information to be added.
2. For the modified files Original license info be unchanged.
3. For the modified files Apache 2.0 license information can be added additionally considering the compatibility of original licnese (MIT)
ReadMe 1. Should follow the base library and also the license.
2. Main point to focus is source information from where we have forked this lib		 ReadMe Template will be shared here.
Android Name changes 1. Library name: Replace android prefix or post fix with ohos.
2. Library name the spelling should be kept intact same as original library including the cases.
Ex1: zxing_android -> zxing_ohos.
Ex2: zxing -> zxing android_zxing -> ohos_zxing		 Ex1: action_ios -> action_ohos
Ex2: action_android -> action_ohos
Ex3: ios_action -> ohos_action
Ex4: android_action -> ohos_action
Check the new comments added 1. Any new comment added should make sense and give some info.
2. In the same way if new logic is added add proper comment
Logs 1. We should not add unneccesary logs or debug logs.
2. Logs should not print sensitive information.
TODO's Only valid TODO's to be added
Generated files Any tool chain generated code should not be added to github Apart from basecode all the generated code should be avoided We can create .gitignore which should handle basic files but as reviewer we can double check this.
Clean up Code Remove code which is not relevant for openHarmony some android util class or resources which are not useful in harmony

Home

General topics

HarmonyOS

JS and ETS development

Android

App Developers Guide for Libraries

Clone this wiki locally