Code Review - Nov.13 #9
Description
Overall:
The main branch—master is grouped in an understandable manner. Papers are given as convincing support and c++/android codes are separately placed in different folders. Descriptions, labeled in #, indicate their everyday progress. The Readme.md file seems not carefully composed, for the Readme.md are almost the same in different branches. This won’t be a big problem for the one who is familiar with the project but it’s hard for people who do not work with them to follow their pace.
Sub branch:
The whole structure of different branches are mostly identical, some slight modifications appear in each one’s work. I assume the personal branches are created under master and share the same file source, while each team member modifies and polishes their own parts and “pull request” to the master branch. They are working in a way that is greatly encouraged by Github, rather than simply uploading files to the hub, like what “Google Drive” functions.
There are still some small suggestions:
- Add some instructions for running/installing the Android application.
If the app is prepared for open, free download in the future, a brief instruction is necessary. - Code is easy to follow but might not follow all PEP-8 conventions.
The variables are easy to read and are descriptive. Some lines may be longer than 78 characters long which is part of the PEP-8 convention. Take a look at the documentation and see if line continuation methods might be beneficial to you. - Pay more attention on Readme.md. The tiny file is essential in showing what you’ve done and tracking your progress.