Browse Source

updated read me and added requirement

Nhu Nguyen 6 years ago
parent
commit
01a6a7428b
2 changed files with 23 additions and 1 deletions
  1. 3
    1
      readme.md
  2. 20
    0
      requirement.md

+ 3
- 1
readme.md View File

@@ -25,7 +25,9 @@
25 25
 # Part 1 - Add tests
26 26
 Add test and make sure the line of code coverage is 100%.
27 27
 
28
-DO NOT alter the Item class or Items property.
28
+DO NOT alter the Item or Inventory class.
29
+
30
+Here are the requirements for the shop. [Link](./requirement.md) This is optional reading, but it will help you create your tests.
29 31
 
30 32
 ## Part 2 - Refactor the code
31 33
 

+ 20
- 0
requirement.md View File

@@ -0,0 +1,20 @@
1
+## Gilded Rose Shop Requirements
2
+
3
+Hi and welcome to team Gilded Rose. As you know, we are a small inn with a prime location in a prominent city run by a friendly innkeeper named Allison. We also buy and sell only the finest goods. Unfortunately, our goods are constantly degrading in quality as they approach their sell by date. We have a system in place that updates our inventory for us. It was developed by a no-nonsense type named Leeroy, who has moved on to new adventures. Your task is to add the new feature to our system so that we can begin selling a new category of items. But before you can add a new feature, you need to add a test that provides 100% line coverage for the Inventory class.
4
+
5
+First an introduction to our system:
6
+
7
+All items have a SellIn value which denotes the number of days we have to sell the item
8
+All items have a Quality value which denotes how valuable the item is
9
+At the end of each day our system lowers both values for every item
10
+Pretty simple, right? Well this is where it gets interesting:
11
+
12
+Once the sell by date has passed, Quality degrades twice as fast
13
+The Quality of an item is never negative
14
+"Aged Brie" actually increases in Quality the older it gets
15
+The Quality of an item is never more than 50
16
+"Sulfuras", being a legendary item, never has to be sold or decreases in Quality
17
+"Backstage passes", like aged brie, increases in Quality as it's SellIn value approaches; Quality increases by 2 when there are 10 days or less and by 3 when there are 5 days or less but Quality drops to 0 after the concert
18
+Just for clarification, an item can never have its Quality increase above 50, however "Sulfuras" is a legendary item and as such its Quality is 80 and it never alters.
19
+
20
+DO NOT alter the Item class or Items property as those belong to the goblin in the corner who will insta-rage and one-shot you as he doesn't believe in shared code ownership.