Improve makefile and pre-commit - #56
Merged
Merged
Conversation
- Add install, format, lint, and clean targets to the Makefile to automate various operations - Execute the install target to perform all project setup operations at once, preventing forgotten pre-commit installations - Modify pre-commit lint/format to reference the local repository and execute lint and format as defined in the Makefile - Modify HTML coverage report output process to clean up the directory beforehand - Set the 'all' target as the default for the make command, enabling simultaneous execution of format/lint/test
Add `log_format` to enhance log readability
- Simplify development environment setup steps in CONTRIBUTING.md and add a warning about pre-commit configuration - Unify the method for installing dependencies and activating the virtual environment in README.md using `make install`
ryansurf
reviewed
Jul 24, 2024
ryansurf
left a comment
ryansurf
left a comment
Owner
There was a problem hiding this comment.
Looks good! The development environment needed to be simplified, the make install command is wonderful.
Owner
There was a problem hiding this comment.
Much more simple for potential contributors, nice!
| send_email_docker: | ||
| docker compose exec flask poetry run python src/send_email.py | ||
|
|
||
| .PHONY: clean |
| .DEFAULT_GOAL := all | ||
| sources = src tests | ||
|
|
||
| .PHONY: install |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
@ryansurf
I have improved the Makefile and pre-commit configuration.
For details, please refer to the commit message a81f423.
Additionally, I've set up the make install command to build the development environment with a single command, ensuring that
pre-commit installis executed reliably(ref #54 (comment)). Along with this modification, I've also updated the content ofREADME.mdandCONTRIBUTING.md.1a8d4bd
I kindly request your review.