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

Add definition of glue to docs #933

Open
rowanbarrie opened this issue Nov 16, 2023 · 1 comment
Open

Add definition of glue to docs #933

rowanbarrie opened this issue Nov 16, 2023 · 1 comment
Labels
good first issue Good for newcomers

Comments

@rowanbarrie
Copy link

πŸ‘“ What did you see?

No formal definition of "glue" is present in the Cucumber docs

βœ… What did you expect to see?

A brief definition of "glue" somewhere before related flags and properties (e.g. --glue, cucumber.glue) are introduced.

For a newcomer it is not necessarily clear what glue is, and why it's needed. It is stated in passing in step-organization.md and implied several places in api.md, but a simple, brief definition somewhere before related code is introduced would make it easier to understand.

@mlvandijk
Copy link
Member

Hi @rowanbarrie - thanks for pointing that out.
Is this something you'd be willing to contribute? The place for it imho would be under "terms": https://github.com/cucumber/docs/tree/main/content/docs/terms
We should add a file called glue.md, similarly to user-story.md but with content for "glue" instead of "user story".

@mlvandijk mlvandijk added the good first issue Good for newcomers label Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants