You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Summary
Introduce a Makefile to simplify and streamline the process of setting up the development environment. This will allow contributors to execute Docker commands more efficiently and reduce the dependency on lengthy, manual instructions in the documentation.
Problem Statement
Currently, the repository lacks a Makefile. Contributors are required to manually execute long Docker commands, as outlined in the installation documentation. This process is repetitive and error-prone, especially for new contributors unfamiliar with Docker.
How will this change help?
This change will help by simplifying the setup process for contributors, making it more efficient and less error-prone. Instead of manually executing long and complex Docker commands, contributors can use simple make commands (e.g., make build, make run, make clean) to handle the entire workflow. This reduces the likelihood of mistakes, saves time, and ensures a more consistent environment for all contributors. It also lowers the entry barrier for new contributors who may be unfamiliar with Docker, making it easier for them to start contributing quickly.
Benefits
Reduces the need to memorize and execute long commands.
Lowers the barrier to entry for new contributors.
Improves consistency and productivity for all contributors.
Screenshots
No response
How could it be implemented/designed?
Proposed Solution
Add a Makefile with predefined targets to automate the Docker workflow. Suggested targets include:
make build: Build the Docker image.
make run: Build and run the Docker container.
make clean: Remove Docker images and clean resources.
Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request. Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
@akshatnema May I work on this issue? As a developer myself, I found the need for this improvement. It's tedious to refer to the documentation and manually execute the commands each time.
YashGupt29
changed the title
[FEATURE] : Add a Makefile for Streamlined Development Environment Setup
[FEATURE] : add a makefile for local docker env setup
Nov 23, 2024
Why do we need this improvement?
Summary
Introduce a Makefile to simplify and streamline the process of setting up the development environment. This will allow contributors to execute Docker commands more efficiently and reduce the dependency on lengthy, manual instructions in the documentation.
Problem Statement
Currently, the repository lacks a Makefile. Contributors are required to manually execute long Docker commands, as outlined in the installation documentation. This process is repetitive and error-prone, especially for new contributors unfamiliar with Docker.
How will this change help?
This change will help by simplifying the setup process for contributors, making it more efficient and less error-prone. Instead of manually executing long and complex Docker commands, contributors can use simple make commands (e.g., make build, make run, make clean) to handle the entire workflow. This reduces the likelihood of mistakes, saves time, and ensures a more consistent environment for all contributors. It also lowers the entry barrier for new contributors who may be unfamiliar with Docker, making it easier for them to start contributing quickly.
Benefits
Reduces the need to memorize and execute long commands.
Lowers the barrier to entry for new contributors.
Improves consistency and productivity for all contributors.
Screenshots
No response
How could it be implemented/designed?
Proposed Solution
Add a Makefile with predefined targets to automate the Docker workflow. Suggested targets include:
make build: Build the Docker image.
make run: Build and run the Docker container.
make clean: Remove Docker images and clean resources.
🚧 Breaking changes
Yes
👀 Have you checked for similar open issues?
🏢 Have you read the Contributing Guidelines?
Are you willing to work on this issue?
Yes I am willing to submit a PR!
The text was updated successfully, but these errors were encountered: