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

Readme example is overly complicated #316

Open
technomage opened this issue Dec 14, 2023 · 3 comments
Open

Readme example is overly complicated #316

technomage opened this issue Dec 14, 2023 · 3 comments
Labels
enhancement Improvement of existing features or bugfix k::documentation Related to project documentation

Comments

@technomage
Copy link

technomage commented Dec 14, 2023

The feature and step examples in the readme involve a dependency (which requires more than a simple dependency line), and introduces async behavior with delays without making it clear if those are required or just to slow down the example run. Also, the paths for each file should be shown to make it clear where things are assumed to be. As a new rust user trying to get a project setup for the first time with cucumber this is overly complicated. A comment should be added to note that the path in the main function is to the features directory to run.

@tyranron tyranron added enhancement Improvement of existing features or bugfix k::documentation Related to project documentation labels Dec 15, 2023
@tyranron
Copy link
Member

@technomage would love to see a PR from you, which makes things more clear on your opinion.

@corebreaker
Copy link

corebreaker commented Mar 2, 2024

So much question, no solution can be found in documentation:

  • In readme, path files is not clear.
  • No more information in project structure.
  • Where is located the implementation of World in tests ?
  • Complete example (in a examples directory in this repository) is missing.

@exo-cortex
Copy link

The readme example does not run for me. I think there are a lot of extra steps that I don't know about. Which parts of Tokio do I have to add? Running cargo add cucumber tokio does not work apparently.
IMHO the code example should either come with more (full) instructions to get it running, or it should be simpler.
Maybe the example int he book with the Cat that is being fed would be better?
Ideally there would also be an examples-folder in the repo which contains this example So that it actually runs (which is easier to test if it exists as actual code instead of cited code in a markdown document.
The Cucumber Rust Book which is referenced to in the readme has lots and lots of examples that I cannot find anywhere. The first I tried I didn't get to run. There are a lot of missing pieces that someone more experienced might intuitively know. If one could really just run the example in the readme and it works out of the box then it is much more likely that someone keeps using it.

If examples do not exist in an examples folder that a directory-tree of the needed files and their locations would be very helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement of existing features or bugfix k::documentation Related to project documentation
Projects
None yet
Development

No branches or pull requests

4 participants