Ability to expose BDD tests written for a component as part of it’s documentation
- Dominant language
- JavaScript
- Stars
- 598
- Forks
- 371
- PR merge metrics
- No merged PRs in 30d
Description
The use case for this is the following:
1. A Business Analyst or Product Owner writes the requirements for the implementation of a component using [Gherkin](https://github.com/cucumber/cucumber/wiki/Gherkin)
syntax
2. Then, a developer uses this information to write actual Gherkin tests for the component (using [Yada](https://www.npmjs.com/package/yadda)
for example) and adds it to the component library
3. Later on another BA, needs to write requirements for the addition of the same component in another place in the app, and would like to know which behavioral scenarios is the component covering.
The idea then, would be to expose the Gherkin scenario definitions (which are human readable) as part of the documentation that is generated for the component.
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no files, tests, or entry points. Start by locating how component documentation is generated and how Yadda or other Gherkin tests are stored, then define how their human-readable scenario definitions should appear in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100