Response to Review of ÕIS 2 Chatbot - Terminaator/chatbot GitHub Wiki

Review

Bugs

• Fixed the typo in possibleTopics

Duplicates

• Removed duplicate method synthesizeWord in StructuralUnits

Anti-Patterns

• We tried to keep code style consistent, so we are writing all methods and variables in camel case. There were some methods and variables that were with underscores instead, changed those to camel case as well.

Inconsistencies

• Fixed inconsistency with the 'eap' word usage in code - Changed those to uppercase, but left these to lowercase in tests, because it shouldn't matter what case the user uses when asking a question.
• Did not fix the inconsistent usage of 'eap'de' and 'eapde'. 'eapd' was used as one of the tag word.
• Didn't fix the inconsistency with bot introduction, because it is more versatile when bot can answer differently to the question who it is.
• Fixed the inconsistent use of variable language (both Estonian and English was used). Now only in english.
• Fixed the inconsistent use of camel case. Class names are capitalized, other variabels and methods use camel case
• Fixed the inconsistent class name usage.

Other notes

• Our TODO comments were not issues, these were to stand out more from other comments and remind the team what should be added to make the code work.

Installation Test

• Added those installation instructions.

Acceptance Test

• Fixed the mentioned typos.
• Who questions were somehow lost with refactoring. Adding those back in.
• There was one "what" question that wasn't implemented, removed that tagword.
• Fixing those other issues, that didn't work as expected.

Overall comments to the review

Most of the issues were with code style, inconsistency. Some of the use cases didn't work as expected, but that was okay, we knew (at least most of them) that these didn't work yet.