CS-46X
/
app
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add code review remarks.

This commit is contained in:
Danila Fedorin 2020-05-15 21:35:53 -07:00
parent b0e8b7fe1c
commit 3bcf1ff545
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
REVIEW.md Normal file
View File

@ -0,0 +1,8 @@
# Code Review Changes
|Comment|Adjustment|
|-------|----------|
|The package `com.danilafe.fencelessgrazing` can be changed to something more relevant.| Package name follows standard conventions of reverse domain name. No changes made.|
| (General remark) commenting is sparse.| Every function and field in the codebase documented using KDoc; documentation intermittently updated on [student website](https://web.engr.oregonstate.edu/~fedorind/CS46X/app/index.html).|
| No unit tests| Not worth it to do UI tests; [cow description language](https://dev.danilafe.com/CS-46x/cdl) developed for testing databases elsewhere.|
| Missing README. | README added with compilation instructions; gradle wrapper adjusted to work out of the box.|