amiceli / vitest-cucumber

Use gherkin in your unit tests with vitest
https://vitest-cucumber.miceli.click
41 stars 5 forks source link

Added Clarification for Documentation #129

Closed saiNaruUFL closed 3 weeks ago

saiNaruUFL commented 2 months ago

Pull Request for providing modifications for ReadME. I proposed two changes which is improving the initial feature example and adding the hook documentation into the ReadME.

Feature Example: I feel the example to explain the scenario test is not as clear and could be improved (which is provided in the change). I provided a mock scenario of a search feature which more clearly shows the test structure d

Hook Example: Another modification that I think would be good is to include the 'Hook' documentation into the GitHub readme. I found this really useful while making personal tests and it may useful for other devs to directly see it in the readme. I also included a pseudo-code of an example of how 'beforeEach' should be used.

amiceli commented 2 months ago

Good idea for a better Scenario example. I posted some comment, we can discuss it.

amiceli commented 1 month ago

@saiNaruUFL any news ? it's been a month, I will close this PR.