OpenSource/GildedRose-Refactoring-Kata
1
0
Fork 0
mirror of https://github.com/emilybache/GildedRose-Refactoring-Kata.git synced 2026-02-15 06:21:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Create readme to explain approach

Browse Source
This commit is contained in:
Dan Holmes 2020-12-04 09:06:00 +00:00
parent eb9d5c8f08
commit 9234534172
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
js-jasmine/README.md Normal file
View File

@ -0,0 +1,18 @@
# Gilded Rose
## The task
Take existing legacy code and add a new feature.
## Approach
1. Write tests for existing functionality.
> This allowed me to refactor the code while knowing I wasn't breaking any functionality.
2. Refactor existing code incrementally.
> It is valuable to have the code formatted using best practices. In order not to break existing functionality I refactored incrementally, running tests and commiting after each small change. This refactor made it much easier to add my feature, but will also improve long term reliability of the code, and future proof it for future feature additions.
3. TDD new feature.
> Having performed the previous two steps, this one was very easy.
## Limitations
The test spec required that I did not alter the Item class. This made it more difficult to apply OOD principles. I have instead created a module for each item type, which still allows for encapsulation.