Improve readme: Add Preperation section #785
Closed
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
|
CLA Assistant Lite bot: I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request |
I have read the CLA Document and I hereby sign the CLA
Citrullin
force-pushed
the
improve-readme
branch
from
e30c35b to
edf60a1
Compare
|
@Citrullin thank you for your suggestion. We will be covering this topic adding a CONTRIBUTING file explaining a bit better how to use this repository. We would still keep on top the instructions for those wanting to use the different packages. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What it solves
When a user freshly clones the repository and builds/tests one specific package, it will fail due to missing types.
How this PR fixes it
Just adds a little section in the readme that notifies the reader over this behaviour.