Update README and add docker example (mainly as a base for reproducing issues) #461
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
section on reporting bugs. Also added cmd/docker to provide a simple way for those experiencing issues to provide a reproducible example. Signed-off-by: Matt Brittan <[email protected]>
|
Thanks for adding all this |
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.
Having reviewed current issues, and considered questions raised elsewhere, I feel that we need to provide more information to assist those starting out with the library and those experiencing issues (particularly in regards to the level of information needed when raising an issue).
This pull request significantly updates/enhances the
readme.mdand addscmd/docker(which should be a useful example as well as providing a good base for those wanting to produce a reproducible example of an issue). Note: I considered renamingcmdtoexamplesto make it more discoverable but have left it as-is for now.A key aim of this change is to provide something that can be referred to when replying to issues that provide insufficient information (removing the need to copy/paste from, or provide links to, other issues).