luminousleek/pe

pe's Issues

Inconsistent MSS for edit and append use cases

Bug: MSS for append use case mentions requesting for a specific list of contacts, while MSS for edit use case does not, even though both commands are index based.

Edit:

Append:

Inconsistent behaviour when filtering by different fields

Bug: Trying to filter with a non-existent faculty gives a "Faculty not found" error, but trying to filter with a non-existent skill/language/framework/tag gives 0 people in the filtered list

Steps to reproduce: filter f/asdf, and then filter fr/asdf

Filtering wrong faculty:

Filtering wrong framework:

Before filter:

After filter:

Data Field in Glossary missing examples

Bug: The entry for "Data Field" in the Glossary does not give examples of what certain data fields are (eg skill, framework), which makes it hard for devs to figure out what exactly they are

Missing prefix for deletefromorg command format

Bug: The deletefromorg command format is missing the n/ prefix for NAME, even though the example has that prefix

Incorrect notation for UML sequence diagram in section 4.2 and 4.4

Bug: The objects in the sequence diagram should have a colon in front of the class name, but this is not the case for some objects (e.g. InteractionCommand, CommandResult)

Section 4.2:

Section 4.4:

Interactions do not have index numbers

Bug: The remove command allows users to remove interacations given their index, but no index for interactions is displayed, so users have to manually count which interaction they want to remove.

Steps to reproduce: add interactions to a person

Inputting index 0 gives wrong error

Bug: Inputting index 0 (or negative indexes) gives invalid command format error, should be invalid index error

Steps to reproduce: type view 0

UG mentions filtering by compatability, but not implemented

Bug: The FAQ seems to suggest being able to filter contacts by compatability, but it is not a valid field in the filter command

FAQ:

Filter command docs:

Result message of removing field is misleading

Bug: The result message of removing a field displays the entire person object, rather than the field item removed.

Steps to reproduce: remove any field from a person

Before removing:

After removing (note the part after "Remove data field:"):

User stories contain implementation info

Bug: User stories mention the "delete" command, which is an imlementation detail. In fact in the actual application, the command to delete data fields (e.g. skill, language) is not "delete", but "remove"

UI does not resize when window is resized

Bug: UI elements do not resize when the window is resized, leaving scrollbars cropped out

Steps to reproduce: Resize the UI window (make the width narrower)

Adding an interaction before all recorded interactions causes the person to disappear from the detailed person view

Bug: Adding an interaction on a date before all previous interactions causes the detailed person view to be blank. Using the view command works and does show the interaction added.

Steps to reproduce: View a person with previous interactions, add an interaction before all the interactions. A bit inconsistent, sometimes it works and sometimes it doesn't.

Before adding:

After adding:

View command shows interaction added:

Email is a required field for organisation

Not sure if this should be the case? What if I want to add an organisation but I don't know it's company email?

Email regex not specified in UG

Bug: User guide mentions "Email Regex" to state what form valid emails should take, but there's no mention of what this regex is in the UG. The only way to find out is to enter an invalid email and see the error returned in the app.

Typo in append command example

Bug: should be "web development" and not "web devevelopment"

Repeated information in find command

Bug: The information under the format section of the find command is the same as the information in the "How to find" section

Inconsistent index out of bounds error messages

Bug: Putting out of bounds indexes for the view command and the remove command give different error messages.

Steps to reproduce: try the view and rm commands with invalid indexes

View command:

Remove command:

Inconsistent colouring for UML diagrams in DG

Bug: The UML diagrams in sections 4.1, 4.2 and 4.3 all use different colourings and fonts

Section 4.1:

Section 4.2:

Section 4.3:

No input validation for compatability

Bug: Inputting an invalid compatability value does nothing - it doesn't even give an error. According to the logs, there's an assertion failure, but an exception should be thrown instead.

Steps to reproduce: Edit a person's compatability to 101, or input 101 when adding a person's compatability

Editing:

Adding:

Logs:

dummy report

goodbye!

Faculty field missing common abbreviations

Bug: Faculty field requires the full name of the faculties (apart from fass), which can be quite cumbersome to type. Should be able to type in common short forms (e.g. soc, engin, med)

Steps to reproduce: type in f/engin when adding a person