Skip to content

Commit

Permalink
Merge pull request #365 from SwaminathanViswa/branch-editDeveloperGuide
Browse files Browse the repository at this point in the history
Edit developer guide
  • Loading branch information
SwaminathanViswa authored Nov 11, 2024
2 parents 2d0c5d1 + d80f465 commit eea376d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org/).
* We took references from [OpenCSV](https://opencsv.sourceforge.net/) for import and export commands.
* ChatGPT was used to check for errors and generate some test cases.
* We referred to our TA's usage of "newPage" and "newPageBetween" [here](https://github.com/AY2324S2-CS2103T-F13-1/tp) to set our pagination for the User and Developer Guide
* It was used to generate the first two test cases in RemoveGradeCommandParserTest.java
* It was also used for the usage of `.getStyleClass()` & `.add()` methods in PersonCard.java to display the information clearly.
* We referred to our TA (Wu Xiaoyun) team's usage of "newPage" and "newPageBetween" [here](https://github.com/AY2324S2-CS2103T-F13-1/tp) to set our pagination for the User and Developer Guide.

---

Expand Down Expand Up @@ -589,6 +591,16 @@ Duplicate names)

---

## **Appendix: Planned Enhancements**

Team member count: 5

1. **Implement commands to add/edit assignment details:** Currently, one has to edit the `kontacts.json` file manually to add or remove assignment details. This could be an issue as the information keyed in may be incorrect. We are planning to create commands which can add/edit assignment details (such as assignment name `Ex04` and its respective `maxGrade` fields) to the `assignment.json` file. This is to make the adding/editing of new assignments easier and prevent wrong information being entered.
2. **Include validation for Telegram ID:** Currently, KonTActs does not check for the Telegram ID's length despite it not being a valid username in Telegram. In future updates, we are planning to provide proper Telegram ID validation to prevent users from inputting usernames that are not accepted by Telegram.
3. **Add flexibility to attendance:** Currently, the maximum number of weeks that can be inputted is 14 since there are 14 weeks in a semester (from week 0 to week 13). However, it is possible that the user would want to use it for a different amount of weeks such as during special terms. Thus, we plan on incorporating commands to edit the start or end week of the attendance.
4. **Improve UI of Result Display box:** Currently, the Result Display only shows three lines of message to the user. However, some of the details require more than three lines to be seen. We plan to improve the UI such that users are able to adjust the size of the Result Display box to display more information.
5. **Improve scroll-ability of application:** Currently, when there is a long tag, and the View Window is closed, the scroll of the application does not work. Although there is a [workaround](https://ay2425s1-cs2103t-t11-2.github.io/tp/UserGuide.html#known-issues) to it, it is not efficient and prevents fast usage. So, we plan on editing the View Window and the Main Window to make it more user-friendly.

## **Appendix: Instructions for manual testing**

Given below are instructions to test the app manually.
Expand Down
1 change: 1 addition & 0 deletions docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
* [Implementation]({{ baseUrl }}/DeveloperGuide.html#implementation)
* [Documentation, logging, testing, configuration, dev-ops]({{ baseUrl }}/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops)
* [Appendix: Requirements]({{ baseUrl }}/DeveloperGuide.html#appendix-requirements)
* [Appendix: Planned Enhancements]({{ baseUrl }}/DeveloperGuide.html#appendix-planned-enhancements)
* [Appendix: Instructions for manual testing]({{ baseUrl }}/DeveloperGuide.html#appendix-instructions-for-manual-testing)
* [About Us]({{ baseUrl }}/AboutUs.html)
</site-nav>
Expand Down
1 change: 1 addition & 0 deletions src/main/java/seedu/address/ui/PersonCard.java
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public class PersonCard extends UiPart<Region> {

/**
* Creates a {@code PersonCode} with the given {@code Person} and index to display.
* GPT was used here to help with the usage of .getStyleClass() and .add methods.
*/
public PersonCard(Person person, int displayedIndex) {
super(FXML);
Expand Down

0 comments on commit eea376d

Please sign in to comment.