From 3bcf1ff545d93a7ec19fba87f7d0223a994a3007 Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Fri, 15 May 2020 21:35:53 -0700 Subject: [PATCH] Add code review remarks. --- REVIEW.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 REVIEW.md diff --git a/REVIEW.md b/REVIEW.md new file mode 100644 index 0000000..e1baaf2 --- /dev/null +++ b/REVIEW.md @@ -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.|