Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added PPP #234

Merged
merged 1 commit into from
Apr 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/Team/khooyourun.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Khoo You Run - project Portfolio Page

## Project BadMaths

BadMaths is a study tool focusing on mathematical help and note-taking. Provides features to aid in solving questions
revolving around matrices, quadratic equations, and trigonometric graphs.

## Summary of Contributions

### Code contributed
[Here are my code contributions](https://nus-cs2113-ay2223s2.github.io/tp-dashboard/?search=khooyourun&breakdown=true&sort=groupTitle%20dsc&sortWithin=title&since=2023-02-17&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other&tabOpen=true&tabType=authorship&tabAuthor=khooyourun&tabRepo=AY2223S2-CS2113-F10-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)

### General functionalities implemented

- Created and implemented the initial `BadMaths` class, `Command` class and `Parser` class that helped to facilitate the general
flow of the program. BadMaths class took in user input, Parser class made sense of the user input and Command class executed
the desired features. All the included features in BadMaths depend and run on these 3 classes.

### Features added

- Added a feature to solve quadratic equations. This allows users to input any quadratic equation and BadMaths would be
able to output the answer. If the answer is imaginary, BadMaths would tell the user as such. BadMaths would also find the
minimum or maximum point of the quadratic graph.

### Enhancements added

- Added JUnit Tests to `Quadratic`, `QuadraticParser` and `Parser`.
- Made the code more OOP and improved readability.
- Enhanced code defence by protecting it against bugs and possible exceptions.

### Contributions to the UG

- Contributed the Table of Contents for easy access to various sections of the UG.
- Contributed the section explaining the usage of the Quadratic solver feature.
- Contributed to the FAQ section.

### Contributions to the DG

- Contributed to the section detailing the functionality of the Quadratic solver.
- Created a sequence diagram to further explain how Quadratic Solver works.
- Added User Stories.
- Added instructions for manual testing.

### Contributions to team-based tasks / Review contributions

- Contributed to brainstorming of ideas and feature generation.
- Tracked v1.0, v2.0 milestones.
- Helped group members with code quality checking and general coding advice.
- Helped to review Pull Requests before merging into master branch on Github.