Repository navigation
Recommend test-driven development in guide - #133
renato-umeton wants to merge 1 commit into
Conversation
Added recommendation for test-driven development.
rafiattrach
left a comment
rafiattrach
left a comment
There was a problem hiding this comment.
Thanks @renato-umeton no argument with the advice. One note on where it lands
| @@ -1,5 +1,7 @@ | |||
| # Development Guide | |||
|
|
|||
| We recommend using test-driven development as much as possible. | |||
There was a problem hiding this comment.
nit: CONTRIBUTING.md is probably the better home for this. It already has a ## Testing guidelines section whose first bullet is "Add tests for any new functionality or bug fixes", which is the same advice one step further along, and CONTRIBUTING.md is what a first-time contributor opens first.
Here the sentence sits above ## Setup, which is the section about installing uv, so it reads as a preamble to the whole document rather than as guidance about testing.
Worth a second thought either way: the repo already asks for tests on every change and CI enforces it, so a line saying to write them first only earns its place if it says something the existing bullet does not. Something like "write the failing test first, then the handler" would at least be concrete.
There was a problem hiding this comment.
Updated contribution guidelines to recommend Test-Driven Development in this file per @rafiattrach request in PR MIT-LCP#133
The reviewer of MIT-LCP#133 asked for two things: the advice belongs in CONTRIBUTING.md under Testing guidelines, which is what a first-time contributor opens, and it should say something the existing "add tests" bullet does not. Writing the failing test first is the concrete part, so it is now the first bullet of that list, and the workflow step goes back to its original wording.
|
Closed in favour of #144, which puts the sentence in CONTRIBUTING.md as the first Testing guidelines bullet. |
* Recommend Test-Driven Development in guidelines Updated contribution guidelines to recommend Test-Driven Development in this file per @rafiattrach request in PR #133 * docs: recommend test-driven development in the testing guidelines The reviewer of #133 asked for two things: the advice belongs in CONTRIBUTING.md under Testing guidelines, which is what a first-time contributor opens, and it should say something the existing "add tests" bullet does not. Writing the failing test first is the concrete part, so it is now the first bullet of that list, and the workflow step goes back to its original wording.
2 participants
Added recommendation for test-driven development.