docs: add make help message and update contributing instructions #249
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
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
toph-allen
approved these changes
Jul 29, 2024
jonkeane
reviewed
Jul 29, 2024
Comment on lines
+64
to
+81
| help: | ||
| @echo "Makefile Targets" | ||
| @echo " all Run deps, dev, test, lint, and build" | ||
| @echo " build Build the project" | ||
| @echo " clean Clean up project artifacts" | ||
| @echo " cov Generate a coverage report" | ||
| @echo " cov-html Generate an HTML coverage report and open it" | ||
| @echo " cov-xml Generate an XML coverage report" | ||
| @echo " deps Install dependencies" | ||
| @echo " dev Install the project in editable mode" | ||
| @echo " docs Build the documentation" | ||
| @echo " fmt Format the code" | ||
| @echo " install Install the built project" | ||
| @echo " it Run integration tests" | ||
| @echo " lint Lint the code" | ||
| @echo " test Run unit tests with coverage" | ||
| @echo " uninstall Uninstall the project" | ||
| @echo " version Display the project version" |
There was a problem hiding this comment.
OH, this is nice + helpful. I will say that it will really cut out my RTFSing of makefile time though!
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.
No description provided.