Pre-checkpoint cleanup

[berkan-sahin]

There are only a few hours left before the first checkpoint. We are (un)officially in a feature freeze and in a need to clean up the code prior to submission.

TODO

• [x] Clean up inappropriate/unnecessary comments
• [x] Check variable naming
• [x] Summarize our progress
• [x] Write each member's contribution
• [x] Complete documentation
• [x] Merge Models to master
• [x] Make release 0.0.1
• [x] Add a version w/ readme.txt as an artifact
• [x] Submit the code (the submitting member closes the issue)

[berkan-sahin]

@whymeeverytime could you post the announcement made by A.Dayanık here?

[friberk]

I haven't seen any problems with variable naming

[whymeeverytime]

[whymeeverytime]

I don't think there is an unnecessary comment. I think we can check that box in the list.

[berkan-sahin]

@vedattt @Apu322 guys, can you check the documentation? (You can credit Vedat where credit's due) Also we need to write everyone's contribution

[berkan-sahin]

• Berkan Şahin -> Model Classes (Unit & Style Testing Logic) + Docker Composition
• Berk Çakar -> Style Checker (Regex Logic and Checker Classes)
• Borga Haktan Bilen -> Model Classes + Style Checker Classes
• Alp Ertan -> Unit Test related classes (Exceptions) + Style Checker Classes
• Vedat Eren Arıcan -> TestResult + Sytle Checker (Regex Logic) These are the current contributions in the README file

[whymeeverytime]

For the Current Status: Testing logic (Unit test and style checker) was implemented, as well as the general I/O infrastructure for files needing persistent storage. Assignment, submission, and user type model classes were also implemented.

[whymeeverytime]

For the Further Development: The only "business logic" needing implementation is the Live Session logic. Once unit classes are complete, Repository classes for DB queries must be written (most of the heavy lifting is already done by Spring Data), and a REST API should be provided for manipulating the model classes. After this, the frontend code will be written based on the UI report and the REST API provided by the backend.

[berkan-sahin]

The status (and further dev.) seems complete to me

[berkan-sahin]

Created PR #16 to merge the backend code until this point to master

[berkan-sahin]

The docs seem complete to me. If someone else can confirm, we can move on with the merge.

[berkan-sahin]

Proceeding with release. Will write later once submission zip is ready

[berkan-sahin]

@friberk will submit the code and close the issue

[friberk]

God bless G2C 🙏🏻