godog icon indicating copy to clipboard operation
godog copied to clipboard

Provide a list of useful extensions

Open nhatthm opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe. This is not a technical problem

I'm very interested in using godog in my tests and it's super convenient. However, I find it is lack of visibility on existing extensions that I could use. In the end, I come up with my own implementation.

I think it's better for the community if we could provide a list of useful extensions.

I also have mine to share (5 extensions)

Describe the solution you'd like

There are 2 options:

  1. We could add a list directly to README.md
  2. We could add a list to a new file EXTENSIONS.md and add a link to README.md

The list would be like this

Extension Description
owner/repo Support a cool feature

Describe alternatives you've considered n/a

Additional context n/a

nhatthm avatar Jul 27 '21 08:07 nhatthm

There are roughly speaking two models to maintain lists like these:

  • An un-curated list. Everyone adds their extension to the list. Unfortunately nobody ever wants to prune old, stale or dysfunctional entries. As such the usefulness of such a list falls of in time quite rapidly.
  • A curated list. Maintainers would add only "worthy" extensions to the list. Maintaining lists like this is rather time consuming.

So perhaps it would be better to use a Github topic instead. Godog is tagged with a few:

image

And clicking any of these will lead to search results that can be sorted on stars or recent updates. This allows for some form of community curation.

https://github.com/topics/integration-testing?o=desc&s=stars

So by tagging all extensions with the same topic e.g. godog-extension the list will create itself. The README.md would only have to mention this convention.


That said, at a glance your extensions appear to be pre-written step definitions. This pattern comes up quite frequently in various implementations of Cucumber. It is also pattern that has proven itself to be detrimental to writing good gherkin as the steps are generally speaking too low level to be any use at communicating with non-technical users.

See:

https://aslakhellesoy.com/post/11055981222/the-training-wheels-came-off

mpkorstanje avatar Jul 27 '21 10:07 mpkorstanje

So by tagging all extensions with the same topic e.g. godog-extension the list will create itself. The README.md would only have to mention this convention.

This is also cool 👍   we could use it.

nhatthm avatar Jul 27 '21 10:07 nhatthm