Add a CONTRIBUTING.md to clarify project structure and valid contributions

[chiroptical]

READ ME BEFORE SUBMITTING A PR

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.

• [x] I acknowledge that this PR is not a solution to the Gilded Rose Kata, but an improvement to the template.

Please provide your PR description below this line

Discussed here: https://github.com/emilybache/GildedRose-Refactoring-Kata/pull/548#issuecomment-2156754222

I remembered you already had some of this in README.md and therefore I extended it with a recommended project structure. It is obviously tricky because the language conventions can vary greatly (e.g. Java versus gleam).

I also added a TODO in the PR template to ensure contributors read the section on adding a new language.

If you would rather move this whole section to CONTRIBUTING.md I am happy to do so 😄

[emilybache]

I like your suggestion of a new file CONTRIBUTING.md

The suggested text updates are good ones.

[codecop]

The contribution file could also contain the text the pr template contains plus sentence to not send solutions. Let's see the contributing.md

[codecop]

Very Nice. In two recent PR for c# I had some discussion with the contributer about naming of folders and independent folders aka duplicated code. If you could find these (one was merged, one not) and add the content accordly

[chiroptical]

Very Nice. In two recent PR for c# I had some discussion with the contributer about naming of folders and independent folders aka duplicated code. If you could find these (one was merged, one not) and add the content accordly

I assume you mean https://github.com/emilybache/GildedRose-Refactoring-Kata/pull/544 and https://github.com/emilybache/GildedRose-Refactoring-Kata/pull/549. You want to add something along the lines of,

A single sub-directory per language is not enforced. A language may have more than one popular unit testing framework. In that case, please add {language}-{framework}/ and maintain separation between the projects. In other words, all the components requested should exist in both sub-directories. Re-using code between the directories would be confusing for those looking for a starting point.

[codecop]

Yes exactly

[chiroptical]

Yes exactly

See https://github.com/emilybache/GildedRose-Refactoring-Kata/pull/550/commits/25c4931f7646399acdb831002f850acaca19c64b

[codecop]

This is great. @emilybache can you think of anything else to put into the contributing.md?

[emilybache]

Thankyou for all your work on this! I'm happy with how it looks and I hope Peter will merge it soon.

[codecop]

Thank you

[emilybache]

Thank you both!