Add examples #183
Merged
Add examples #183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is a common best practice to have well documented examples which showcase the usage of a project. Until now we pointed to some of the integration tests for this. They are however a bad fit for this. Their documentation is only the minimum to understand the test cases and often they test edge cases not relevant for the user.
Many README files in the aspect integration tests simply state the obvious. We started having a README for each integration test due to the overall documentation pointing to those tests. Now that we have dedicated examples, we delete all README files without valuable information.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is a common best practice to have well documented examples which showcase the usage of a project. Until now we pointed to some of the integration tests for this. They are however a bad fit for this. Their documentation is only the minimum to understand the test cases and often
they test edge cases not relevant for the user.