Giter Site home page Giter Site logo

pe's People

Contributors

lipwei1808 avatar

Watchers

 avatar

pe's Issues

Add command is too long and restrictive

Description

The add command is too long and restrictive. It enforces the presence of every single field which might prove to be too restrictive as there might be scenarios where a user might not want to enter all the fields and want to quickly enter a user into the application. As an application optimised for CLI, the commands should be easy to type. The long command with many different prefixes to remember might prove to be a feature flaw as it is not truly optimised for CLI users.

Reason for severity

Likely to affect a large portion of users at the very beginning when they first use the application. Severity decreases as users gets used to the application and uses it more.

Help window jumping around

Description Set the context.

Help window jumping around

Steps to reproduce

  1. Type the help command
  2. Shift the help pop up anywhere
  3. Close the help pop up
  4. Type the help command again
  5. The help window will jump around

I have attached a video recording of the replication

Expected behaviour

The help window should show up like the first time

Actual behaviour

The help window jumps to the bottom left corner before jumping to the the middle again

Reason for severity

Does not affect daily usage of users. Unlikely to occur alot after some level of use as the users should be familiar with the commands and
would not need to keep referring to help.


video:https://raw.githubusercontent.com/lipwei1808/pe/main/files/785e67e3-2b7a-441b-87be-2f34fde3add7.mov

Inconsistent use of colour in diagrams

The use of the greyish-green colour seemed to be used to demarcate the Person encapsulation. However it can be seen to be repeated again in other areas of encapsulation

Unclear use of colour scheme of diagrams
Screenshot 2023-11-17 at 5.28.43 PM.png
Screenshot 2023-11-17 at 5.28.48 PM.png

Unable to add benefit by the provided error response

Description

Upon entering an invalid command for benefit, there is an error response as attached. However using any of those options would lead to an invalid command still.

Expected behaviour

The command should be accepted as stated

Actual behaviour

The command is rejected

Reason for severity

This could affect a large amount of users as they try to add a benefit and would be stuck not knowing why their command is rejected
Screenshot 2023-11-17 at 5.08.56 PM.png

Large minimum view width

Description Set the context.

The minimum view width of the application is very high

Expected behaviour

The minimum view width of the application is almost 80% of my screen which is a 14 inch macbook. This could inconvenience users using a different platform with a smaller width. They might not be able to view the application fully.

Actual behaviour

There should be actions done to provide responsive display and allow for a smaller width.

Reason for severity

An issue that could affect a significant portion of users using computers with a smaller display. However it would not affect functionality but cause a minor inconvenience. However, as it could potentially cause users to constantly move around the display, the severity could increase to medium if the portion of users affected turns out to be higher

Screenshot 2023-11-17 at 4.18.17 PM.png

Weird use of index to select person

Description

Unclear use of selection index to choose Person.

Steps to reproduce

Based on the original list, there was a person on index 4. As I want to view the payslip for the person at index 3 followed by the person at index 4

  1. Run the command payslip 3
  2. Run the command payslip 4
  3. An invalid index is shown

Expected behaviour

Step 2 results in an error of invalid index.

Actual behaviour

I should be able to view payslip of the person at index 4 on the original list

Reason for severity

There is not a clear documentation on how the index is used. It is intuitive for the user to wish to view payslips of multiple people successively. However, with the unclear use of index, there seems to be issues with this.

Ideas

This might be caused by the use of index in finding people from the filtered list already. If so, there should have been a clearer documentation to prompt users to reset the list with list again before running any other commands

Screenshot 2023-11-17 at 4.38.57 PM.png

test

No details provided by bug reporter.

Incorrect use of ref frames in diagram

The use of the ref frame in this diagram is incorrect. To use a ref it should be ref and not sd.

The sd should be used when displaying the content of a ref

Screenshot 2023-11-17 at 5.38.50 PM.png

Email validation is too strongly validated

Description

The email validation is too strongly validated which restricts user inputs.

Steps to reproduce

  1. Run the command add /n Jane Smith /e Pelé@example.com /p 12345678 /a 123 Main St /b123456789 /jd 12/09/2023 /s 1000.00 /l 10.
  2. The input will be rejected as the email is not valid

Expected behaviour

The input is rejected by the application

Actual behaviour

The input should be valid.

Reason for severity

In accordance to RFC 6530, the email I provided should be valid. However, the email validation logic only allows for a much smaller restricted set of alphanumeric characters. This could prove to be an inconvenience to a significant chunk of users.

Screenshot 2023-11-17 at 4.22.55 PM.png

Leaves does not get recorded properly

Description Set the context.

Leaves does not get recorded properly

Steps to reproduce

  1. Add a few leaves by using addleave
  2. Edit the Person leave to be lower
  3. Add another leave.
  4. The previous leave entries are deleted

This issue can be replicated by closing the application after editing a Person leave. Upon reopening the application, the leaves that were previously entered would be lost.

A video recording of this is attached

Expected behaviour

The leaves that were previously added should remain

Actual behaviour

The application deletes the leaves that were recorded prior to the edit

Reason for severity

This could affect many users as it is highly likely that leaves will be updated throughout the year and it is a huge inconvenience to re update all the previously added leaves.

Screen Recording 2023-11-17 at 5.04.52 PM.zip

Screen Recording 2023-11-17 at 5.04.52 PM.zip

Unable text on the Model class diagram

Text on the image of the class diagram should roughly match the size of the text outside of the diagram. However, the words in the diagram is too small and hard to read.

Screenshot 2023-11-17 at 5.15.13 PM.png

Duplicate detection with spaces in name

Description

Duplication detection is not optimised

Steps to reproduce

  1. Run add /n Jane Smith /e [email protected] /p 12345678 /a 123 Main St /b 123456789 /jd 12/09/2023 /s 1000.00 /l 10
  2. Run add /n Jane Smith /e [email protected] /p 12345678 /a 123 Main St /b 123456789 /jd 12/09/2023 /s 1000.00 /l 10
  3. Both commands will run successfully

Note the only difference in the 2 commands is the name field.

Expected behaviour

As the 2 people are most likely to the be the same person, the application should reject adding the 2nd command.

Actual behaviour

The application allows for 2 people with the same name but varying spaces within the name to be added.

Reason for severity

As the name field does trimming of whitespaces, there should be optimisation done to prevent duplicates through having spaces within the name as well. Since the name "Jane Smith" and "Jane Smith" are most likely the same person, there should be control done to prevent adding these 2 duplicate people with exactly the same fields.

Screenshot 2023-11-17 at 4.27.46 PM.png

Use of addressbook seems out of place

Use of AddressBookStorage and AddressBookParser seems out of place given there has been no mention of 'AddressBook' throughout the application. The class could be renamed to better fit the application.

Screenshot 2023-11-17 at 5.31.44 PM.png

Screenshot 2023-11-17 at 5.36.12 PM.png

Text input unscrollable

Description

The text input is unscrollable

Steps to reproduce

I have attached a screenshot of the replication

Expected behaviour

The input box should be scrollable when the input text is longer than the width of the input box.

Actual behaviour

Input box is unscrollable.

Reason for severity

The input box being unscrollable would cause inconvenience to users that wishes to preview what they wrote and would like to edit.

Given that the first command to add contains a command that already exceeds the input box width, it shows that this issue would be rather prevelant and affect a significant portion of users.

Screenshot 2023-11-17 at 4.19.48 PM.png

Inaccurate Parser class diagram

There should be a dependency drawn from AddressBookParser to XYZCommand given that not all Command has an explicit CommandParser that creates them.

Screenshot 2023-11-17 at 5.33.51 PM.png

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.