Added CONTRIBUTING document, dev requirements #11
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
|
Regarding discussion #9 - I came to a realisation that it is better to keep readmes attached to releases - what if new breaking change is introduced? For less experienced users it will be complicated to figure out which readme to use. They may not know which commands/arguments to run as a result, making script unusable for them. |
dimsanius
added
documentation
|
I agree with your considerations, I'm going to merge the MR. |
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.
Hello again.
I have did some further changes to make this repo look more user friendly.
requirements_dev.txt- it callrequirements.txtunder the hood, so still only one place to adjust modules for release.gitattributesfile - ignoredrequirements_dev.txtfor release zip archive - the rest of repo remain zipped for a release, including all images and readmesCONTRIBUTING.mdguideCONTRIBUTING.mdwithin mainREADME.mdprospectorfromrequirements.txt. Addedprospectortorequirements_dev.txt