Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Experiment]: Behaviour Driven Developement and Living Documentation #810

Open
1 task done
philou opened this issue Oct 8, 2024 · 0 comments
Open
1 task done
Labels
documentation Improvements or additions to documentation experiment An experimentation M Medium refactoring

Comments

@philou
Copy link
Contributor

philou commented Oct 8, 2024

Contact Details

[email protected]

Feature Request

We repeatedly need to explain to new users who want to use TCR for training or in real life how it works and what we can expect out of it.

Feature Description

Use human-readable tests that we can also use as documentation for the main scenarios of TCR.

We could go with Gherkin, or something else.

Learn and decide what to do next

Alternatives

  • classic unit tests
  • keep it as it is
  • add non-executable documentation

Additional Context

There are different ways to implement this:

This experiment could also lead to coaching content

Code of Conduct

  • I agree to follow this project's Code of Conduct
@philou philou added enhancement New feature or request documentation Improvements or additions to documentation M Medium refactoring experiment An experimentation and removed enhancement New feature or request labels Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation experiment An experimentation M Medium refactoring
Development

No branches or pull requests

1 participant