Skip to content

Commit

Permalink
Merge 2d8b07a into 25fbb3d
Browse files Browse the repository at this point in the history
  • Loading branch information
sylchw committed Nov 12, 2018
2 parents 25fbb3d + 2d8b07a commit 6eaa90f
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 26 deletions.
13 changes: 11 additions & 2 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,16 @@ image::CalendarSequenceDiagram.png[width="800"]
// end::calendar[]

// tag::displayScheduleOnCalendar[]
=== [Proposed] Display Schedule on Calendar [V2.0]
=== Schedule Display Calendar Selected Person
This feature allows the calendar of a person to be displayed upon being selected.
==== Current Implementation
This makes use of the calendar feature, which activates the rendering of the calendar upon an event of a person being selected.

Upon the selection of a person, the calendar will overwrite the welcome message view, showing the calendar of the current month.

*It is unable to show the schedules added into the person.*

=== [Proposed] Schedule Display Calendar Selected Person [V2.0]

When a person is selected, the person's schedule should be displayed on the calendar panel.

Expand Down Expand Up @@ -1006,7 +1015,7 @@ details manually
(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)

[discrete]
=== Use case: Add schedule
=== Use case: Add and Match schedule

*MSS*

Expand Down
1 change: 0 additions & 1 deletion docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ Selects the 1st person in the results of the `find` command.
Upon selecting a person, the calendar of the current month will be displayed, instead of the
welcome message.
For additional calendar features, please view `calendar to view schedule`.
//todo link the link to calendar view schedule below

=== Listing entered commands : `history` / `hs`

Expand Down
56 changes: 33 additions & 23 deletions docs/team/driedmelon.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
image::driedmelon.png[width="150", align="left"]
{empty}

== PROJECT:
== PROJECT: 'JitHub' - A Student Meeting Planner:
image::logo.png[width="150", align="center"]

---
Expand All @@ -18,12 +18,12 @@ image::logo.png[width="150", align="center"]

== Overview

`JitHub` is a desktop meeting organising application targeted at tertiary students. Besides enabling you to view common
`JitHub` is a desktop meeting planning application targeted at tertiary students. Besides enabling you to view common
meeting time slots in teams, it includes various meeting tools such as the taking of minutes and a list of todo tasks.
This is done with a Command Line Interface(CLI), and it has a GUI created with JavaFX.
`JitHub` is written in Java, and has about 10 kLoC.

JitHub is developed in a team of five throughout the course of a semester as part of module requirements in the School
JitHub is developed in my team of five throughout the course of a semester as part of module requirements in the School
of Computing, National University of Singapore.

Modules with JitHub as requirements:
Expand All @@ -33,32 +33,43 @@ Modules with JitHub as requirements:

== Summary of contributions

* *Major enhancement*: Added *the ability to view available meeting time slots in teams.*
** What it does: It allows you to view the available meeting time slots based on the calendar of all team members
** Justification: This feature improves the product significantly as it enables you to arrange for group meetings without
* *Major enhancement*: Added *the ability to view common time slots of selected persons.*
** What it does: It allows you to view the available meeting time slots based on the scheduled events of all team members
** Justification: For tertiary students like us, we identified that it is difficult to plan for group project
meetings. Therefore, based on the needs of a tertiary student, it is great to simplify the tedious manual task of finding common
time slots with a feature. This feature is thus a core of the product as it enables you to arrange for group meetings without
manually checking each team member's calendar.
** Highlights: This enhancement affects GUI to be added in future, should the calendar be displayed with a non-text format.
It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes
to existing commands.
** Highlights: To ensure that the schedule feature to view common time slots is easy to use, it required an in depth analysis of
design alternatives. Furthermore, it implements a stringent check on date and time fields to prevent mishandling of entered information.
To have a balance between capability and cost, a 1 day selection period is also implemented to prevent the program from taking too long to respond.
This enhancement affects GUI to be added in future, should the common time slots be displayed in a non-text format
such as by using a calendar display visual.

** Credits: Mr Akshay Narayan, Team Members, Seniors
//_{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in
//the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_

* *Minor enhancement*: added a browser panel which allows people to search for photographs of an added person.
* *Minor enhancement*: Added a Welcome Message on the calendar panel which allows people to search for photographs of an added person.
** Justification: Users needed a prompt when we conducted user tests on week 11 of the semester.

* *Code contributed*: [https://github.com/driedmelon/main/commits?author=driedmelon[Functional code]]
//TODO TO CHANGE TEST CODE LINK AND CLARIFY WHAT LINK TO BE PUT UP
* *Code contributed*: [https://github.com/driedmelon/main/commits?author=driedmelon[Code Dashboard]]
[https://github.com/driedmelo/main/commits?author=driedmelon[Test code]]

* *Other contributions*:

** Project management:
*** Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
** Enhancements to existing features:
** Documentation:
** Community:
*** PRs reviewed (with non-trivial review comments): https://github.com[#45], https://github.com[#50], https://github.com[#62]
*** Reported bugs and suggestions for other teams in the class (TO BE DONE ON 2/11/2018 FRIDAY)
*** Ensured that project meetings were carried out every Monday morning for the setting of direction and the purpose of updating each other.
*** Enhancements to existing features:
**** Increased code coverage from 80% to 83% (Pull requests https://github.com/CS2113-AY1819S1-W12-1/main/pull/201[#201])
*** Community:
**** PRs reviewed (with non-trivial review comments): https://github.com[#45], https://github.com[#50], https://github.com[#62]
**** Reported bugs and suggestions for other teams in the class (Issue https://github.com/CS2113-AY1819S1-T13-2/main/issues/127[#127]
https://github.com/CS2113-AY1819S1-T13-2/main/issues/130[#130]
https://github.com/CS2113-AY1819S1-T13-2/main/issues/144[#144]
https://github.com/CS2113-AY1819S1-T13-2/main/issues/140[#140]
https://github.com/CS2113-AY1819S1-T13-2/main/issues/139[#139]
https://github.com/CS2113-AY1819S1-T13-2/main/issues/126[#126]

** Tools:

//_{you can add/remove categories in the list above}_
Expand All @@ -72,18 +83,17 @@ manually checking each team member's calendar.

include::../UserGuide.adoc[tag=schedule]

include::../UserGuide.adoc[tag=dataencryption]
include::../UserGuide.adoc[tag=calendarViewSchedule]

== Contributions to the Developer Guide

|===
|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
|===

Developer guide not updated online. [Coming soon in v1.4]
//include::../DeveloperGuide.adoc[tag=undoredo]
//
//include::../DeveloperGuide.adoc[tag=dataencryption]
include::../DeveloperGuide.adoc[tag=schedule]

include::../DeveloperGuide.adoc[tag=displayScheduleOnCalendar]


== PROJECT: UTC2101-Time-and-Life-Chatbot
Expand Down

0 comments on commit 6eaa90f

Please sign in to comment.