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

Examples are hard to understand #367

Closed
ingorichtsmeier opened this issue May 20, 2022 · 2 comments · Fixed by #399
Closed

Examples are hard to understand #367

ingorichtsmeier opened this issue May 20, 2022 · 2 comments · Fixed by #399
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@ingorichtsmeier
Copy link

Description

All examples just extend an abstract class with the test implementation.

As a new user looking for examples it's quite difficult to understand, especially if you look up the code on github directly in your browser.

Easy examples without full featured DRY would be much better to learn from.

@ingorichtsmeier ingorichtsmeier added kind/feature Categorizes an issue or PR as a feature, i.e. new behavior team/process-automation labels May 20, 2022
@remcowesterhoud remcowesterhoud added kind/documentation Categorizes issue or PR as related to documentation. and removed kind/feature Categorizes an issue or PR as a feature, i.e. new behavior labels May 20, 2022
@saig0
Copy link
Member

saig0 commented Jun 10, 2022

Good point 👍 Let's add some pure samples for users as part of the repository. We should include the tests in the build pipeline to ensure that the samples are working.

@pihme pihme self-assigned this Jun 13, 2022
@pihme pihme mentioned this issue Jun 14, 2022
7 tasks
@pihme
Copy link
Contributor

pihme commented Jun 14, 2022

@ingorichtsmeier If you find the time, feel free to add your two cents to #399.

It is based on an example we already had, but which got a bit buried in all the files. I hope this is more helpful. Still needs a bit of polish, though.

The other tests will probably stay as they are, but we won't advertise them as examples anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants