docs(glossary): rewrite BDD page with process, Gherkin examples, tools a table and a keploy section - #917
Merged
Conversation
…s table and Keploy section Signed-off-by: amaan-bhati <amaanbhati49@gmail.com>
…ta title Signed-off-by: amaan-bhati <amaanbhati49@gmail.com>
nehagup
reviewed
Sep 23, 2026
nehagup
left a comment
Member
There was a problem hiding this comment.
Big improvement over the old page. The working step definitions, the API section and the SpecFlow → Reqnroll correction are exactly what this page needed, and the Keploy section is positioned well (BDD for intended behaviour, Keploy for regression coverage from real traffic). I checked all the internal links and the new image, and they return 200. Some edits:
- Put the hyphens back. "Behavior driven development", "test driven development", "acceptance test driven development" and "domain driven design" all need a hyphen ("behavior-driven development"). The no-em-dash rule doesn't cover hyphens, and the unhyphenated form looks like an error to the developers reading this. Keep "behaviour driven development" as the alternate spelling, hyphenated too.
- The title in the PR description doesn't match the diff. The description says the new title is "What is BDD (Behavior-Driven Development)?", but the frontmatter has "Behavior driven development (BDD): process, examples and tools". Pick one. I'd lean toward the "What is…" form for the glossary query intent, keeping "examples and tools" in the description.
- Java example leaks browsers.
driver.quit()sits after the assertion in each@Then, so any failing assertion leaves Chrome running. Readers copy these snippets, so move setup and teardown into@Before/@Afterhooks. Better yet, don't create the driver in aGivenat all. - Python example: add
resp.raise_for_status()(or an assert) instep_create_cart. Otherwise a failed cart creation shows up as a confusingKeyError: 'id'. - Dark mode: the new image is
bdd-process-light.webp. Is there a dark variant? If so, it's worth switching to a light/dark pair so the image works in dark mode.
Please run npm run build before merge, as noted in the description.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What has changed?
Rewrite of the BDD glossary page (
/docs/concepts/reference/glossary/behaviour-driven-development/).Type of change
How Has This Been Tested?
npx prettier --checkpasses. All internal link targets verified to exist inversion-4.0.0.npm run buildto be run locally before merge.Checklist: