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

Consider adding a very small working example to the repo and readme #644

Open
jzohrab opened this issue Oct 31, 2023 · 0 comments
Open

Consider adding a very small working example to the repo and readme #644

jzohrab opened this issue Oct 31, 2023 · 0 comments

Comments

@jzohrab
Copy link

jzohrab commented Oct 31, 2023

Hi there,

(again a repeated thanks for this killer project. It has been fun to work with and really adds a lot to my project.)

When I was getting started out I would have appreciated a running example. I had to sort out some issues with file placement and naming, and just simple organization. The readme and various blogs show how to use it, but having something running to hack at is so much nicer.

My idea is that users could just copy a working set of files into their project or an empty dir, run it, and start from there. Something as simple as:

/ example
book.py -- a very simple class
book.feature
test_book.py

The feature would contain the basics: a background, a few scenarios (possibly with one failing so that users could tweak it), some steps with a parser, some without, and the test_book.py would just pull in all of the features.

If you'd like I can kick off an initial draft and PR a draft back to this repo. Cheers, jz

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant