Add Makefile and update documentation #149
Merged
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
Remove infrastructure folder Update requirements.txt
ConnorKirk
reviewed
Feb 15, 2022
ConnorKirk
reviewed
Feb 15, 2022
ConnorKirk
reviewed
Feb 15, 2022
ctd
requested changes
Feb 15, 2022
ctd
reviewed
Feb 15, 2022
ctd
reviewed
Feb 15, 2022
Co-authored-by: Connor Kirkpatrick <ckp@amazon.com>
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
…abekf/documentation # Conflicts: # README.md
ctd
reviewed
Feb 15, 2022
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
Co-authored-by: Chris Deigan <ctd@users.noreply.github.com>
ctd
approved these changes
Feb 15, 2022
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.
Issue #, if available:
N/A
Description of changes:
This PR improves local development. I have introduced Makefile to create virtual environment and install tools such as pre-commit, bum2version and more. Furthermore the whole local development set up has been documented to bring all the contributors on the same environment set up.
Testing
The Makefile and the commands has been tested on following operating systems:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.