-
Notifications
You must be signed in to change notification settings - Fork 55
Create Makefile #534
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
Create Makefile #534
Conversation
We needed to make a makefile such that developers can easily set up their local environments
|
||
# Install the necessary Ruby gems defined in the Gemfile | ||
- bundle install | ||
|
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.
What version of Python should be installed?
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.
Python 3.11.7 will be installed, i have modified the file to reflect this.
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.
@kjaymiller Kindly review the PR again as she has made the changes requested.
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.
Please update your PR message by completely filling out the PR template.
The section explaining why you chose to do a make file (especially versus, nox, tox, or pyinvoke)
Also, address the comment in the makefile about setup for Python.
Issue Link 🔗: #401
Issue: #401
Type of Change
Description 📋
Developers had to run individual commands in order to set up their local environments. This PR solves the issue by having a makefile that the developers can run instead.
I designed a makefile that developers can easily use to set up their local environments.
This Makefile is designed to set up the environment by installing necessary Ruby and Python versions, dependencies, and configuring pre-commit hooks. It also includes commands to start and stop the Jekyll server.
I chose to choose rbenv because I noticed that it was already being used in the codebase and since I am familiar with it, it made sense to continue its usage. rbenv helps to maintain a ruby version in my repository and I wouldn't need to alter the system wide ruby version.
This Makefile automates the setup and management of this project environment, ensuring that all necessary dependencies and configurations are in place. The change is going to make life easier for other developers by using a one line command to set up their development environment.
Checklist ✅
pre-commit run --all
Additional Notes & Screenshots
Add any additional notes or comments that might be helpful for the reviewers.