-
Notifications
You must be signed in to change notification settings - Fork 215
Update Makefile #302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Makefile #302
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@guilt
Thanks for submitting this update, the help improvements look good. Some minor comments to make help messages consistent, looks good otherwise.
libs/aws/Makefile
Outdated
| tests: ## Run all Tests | ||
| poetry run pytest $(TEST_FILE) | ||
|
|
||
| test: ## Run Individual Test: make test TEST_FILE=test.py |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Like the sample commands.
f0bd840 to
7eef101
Compare
Co-authored-by: Piyush Jain <[email protected]>
7eef101 to
41c214f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 🚀
# Issue or Problem Addressed For a new Developer who is starting with the development, list of commands to learn in `make` can be exhausting. # Description - This PR simplifies the setup of a new developer environment by listing all the targets that `Makefile`. - Adding a new target with inline help ensures that the developer can document this without requiring to add in a separate `help` section of Makefile. - This PR runs formatting and spell check fixes and corrects some scripts. # Type of change Please delete options that are not relevant. - [X] Bug fix (non-breaking change which fixes an issue) - [X] New feature (non-breaking change which adds functionality) # How Has This Been Tested? This as tested on my Laptop. ## List of Tests Added N/A ## Test Procedure - [ ] `make` now lists all help targets <img width="1518" alt="Screenshot 2024-12-10 at 2 58 52 PM" src="https://github.com/user-attachments/assets/ad6cf3b7-8a79-43e9-af35-e598e45671c9"> ## Test Configuration - Python Version: `3.12.4` - OS/Distribution: `Darwin 23.6.0 Darwin Kernel Version 23.6.0` # Review Checklist: - [X] My code follows the style guidelines of this project - [X] I have performed a self-review of my own code - [X] I have commented my code, particularly in hard-to-understand areas - [X] I have no changes that break existing user workflows. If so, I am providing a deprecation path - [X] I have added tests that prove my fix is effective or that my feature works - [X] New and existing unit tests pass locally with my changes Co-authored-by: Piyush Jain <[email protected]>
Issue or Problem Addressed
For a new Developer who is starting with the development, list of commands to learn in
makecan be exhausting.Description
Makefile.helpsection of Makefile.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
This as tested on my Laptop.
List of Tests Added
N/A
Test Procedure
makenow lists all help targetsTest Configuration
3.12.4Darwin 23.6.0 Darwin Kernel Version 23.6.0Review Checklist: