From 361cd3dc0119d4946616a5a848ed2819a8c24d6e Mon Sep 17 00:00:00 2001 From: chiroptical Date: Sun, 9 Jun 2024 15:59:43 -0400 Subject: [PATCH] Add a recommended project stucture in README --- .github/pull_request_template.md | 1 + README.md | 11 +++++++++++ 2 files changed, 12 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 76d0e96c..128e5239 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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 diff --git a/README.md b/README.md index d71b9deb..8114f4b7 100644 --- a/README.md +++ b/README.md @@ -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.