OpenSource/GildedRose-Refactoring-Kata
1
0
Fork 0
mirror of https://github.com/emilybache/GildedRose-Refactoring-Kata.git synced 2026-02-04 09:11:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add a recommended project stucture in README

Browse Source
This commit is contained in:
chiroptical 2024-06-09 15:59:43 -04:00
parent 717e2a8c7b
commit 361cd3dc01
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/pull_request_template.md vendored
View File

@ -3,5 +3,6 @@
Please do not submit a PR with your solution to the Gilded Rose Kata. This repo is intended to be used as a starting point for the kata.
- [ ] I acknowledge that this PR is not a solution to the Gilded Rose Kata, but an improvement to the template.
- [ ] I acknowledge that I have read [this section of the README](https://github.com/emilybache/GildedRose-Refactoring-Kata/blob/main/README.md#translating-this-code)
## Please provide your PR description below this line

11
README.md
View File

@ -63,3 +63,14 @@ Please don't write too much code in the starting position or add too many unit t
If your programming language doesn't have an easy way to add a command-line interface, then the TextTest fixture is probably not necessary.
### Recommended project structure
Programming languages have a variety of conventions but the project tries
to maintain some order among the examples. Ideally, the 'update_quality' and
Item definitions should be in a file named `gilded_rose` with your language's
conventional casing (e.g. snake case) and location (e.g. `src/`). The "fixme" !
= "foo" test should go in a file `gilded_rose_test` in your language's
conventional location (e.g. `test/`). The TextTest fixture and command-line
program that simulates update_quality over a number of days should go in
`program` or `texttest_fixture`. If you can define a default for the number of
days in the simulation please choose two days.