search

Programming-Project-2022-23-UniBz / course-project-manuelalessandro

Hotel Management System by Manuel Villotti and Alessandro Marconi
0 stars 0 forks source link

Review of the managment system #3

Open aleski017 opened 1 year ago

aleski017 commented 1 year ago
  1. General

1.1. How creative is the project? (0: I've seen this on Youtube, 1: not creative 2: average, 3: creative, 4: very creative, 5: wow!) 2

1.2. How difficult was it to implement the project? (0: no challenge, 1: very easy, 2: easy, 3: fair, 4: complex, 5: insane) 0

1.3. List 3 positive aspects of the project. Motivate your selection.

  1. Simple yet effective user experience
  2. Detailed login
  3. Great potential for future implementation

1.4. List 3 negative aspects of the project. Motivate your selection.

  1. Some exceptions are not checked (For example: In a booking i can check in the 23rd of september and check out the 15th, which does not makes sense. The total of stays is -8 and the cost is wrong)

  2. The layout and design of the GUI is not well designed

  3. It does not offer a lot of functionalities

  4. Programming techniques

2.1. Evaluate how well 5 programming techniques we learned throughout the course were adopted in the project. Assign a mark from 0 to 5 to each technique, where 0 means completely incorrect usage and 5 means perfect usage.

  1. Testing 2

  2. Logging 5

  3. Try-catch blocks 3

  4. Collections 4

  5. GUI 1

  6. Git repository

3.1. How appropriate is the .gitignore file of the project? (0: missing, 1: very bad, 2: bad 3: average, 4: good, 5: very good) 5

3.2. How appropriate is the README.md file of the project? (0: missing, 1: very bad, 2: bad 3: average, 4: good, 5: very good) 5

  1. Maven

4.1. Can you compile the project via Maven? (0: no, 1: yes, but..., 2: yes) 2

4.2. Can you clean the project via Maven? (0: no, 1: yes, but..., 2: yes) 2

4.3. Can you run the project via Maven? Check README.md on how to run the project. (0: no, 1: yes, but..., 2: yes) 0

4.4. Are the project's dependencies appropriately configured in pom.xml? (0: no, 1: some, 2: yes) 2

4.5. Are all Maven plugins appropriately configured in pom.xml? (0: no, 1: some, 2: yes) 2

4.6. Does the project adopt Maven's standard directory layout? (0: no, 1: yes, but..., 2: yes) 2

  1. Testing 5.1. Are all tests passing? Run mvn test. (0: no, 1: yes, but..., 2: yes) 2

5.2. How well do the tests cover the code? (0: no tests, 1: no important method, 2: some important methods, 3: most important methods, 4: all important methods, 5: 100% test coverage) 3

5.3. Do the tests actually verify the expected behavior of the program? (0: no tests, 1: useless tests, 2: most don't, 3: some do, some don't, 4: most do, 5: awesome tests) 4

5.4. How well can you understand what the tests are supposed to verify? (0: no tests, 1: what is going on?, 2: most are not understandable, 3: some are understandable, some aren't, 4: most are understandable, 5: all test are understandable) 5

  1. Documentation

6.1. How understandable is the Javadoc written for classes, fields and methods of the program? (0: no documentation, 1: very poor, 2: poor, 3: average, 4: good, 5: awesome) 4

6.2. How useful is the Javadoc written for classes, fields and methods of the program? (0: no documentation, 1: irrelevant, 2: little utility, 3: average, 4: useful, 5: very useful) 3

6.3. Can you generate documentation files for this project? Run mvn javadoc:javadoc. (0: no, 1: yes, but..., 2: yes) 0

6.4. How adequate are the non-javadoc comments written throughout the code? (0: mostly inadequate, 1: average, 2: mostly adequate, 3: awesome) 3

  1. Code quality

7.1. Is the code style adopted throughout the project consistent? Consider how whitespace is represented (spaces or tabs), tab size, naming conventions for classes, methods and variables, indentation, braces usage, line width. See Google Java Style Guide as an example of code style guidelines. (0: no, 1: yes, but..., 2: yes) 2

7.2. How would you rate the project in terms of code duplication? (0: a lot of duplication, 1: some duplication, 2: barely any duplication, 3: no code duplication / only justifiable duplication) 3

7.3. How easy it is to understand how the program works by looking at the source code? (0: mostly hard to understand, 1: some fragments are hard to follow, 2: not hard, but not easy, 3: easy to understand) 3 7.4. Is the program excessively inefficient? (0: most methods, 1: many methods, 2: few methods, 3: almost no method) 3

7.5. Does the program crash unexpectedly (e.g. by an uncaught exception)? (0: all the time, 1: rarely, 2: it happened once, 3: never) 3

mamu8manu commented 1 year ago

Hi Alessandro, thank you for the feedback. The project actually can run via Maven as we implemented it in order to easily run the project. If you do not know how Maven can be used, you can read the documentation we wrote in the README file.