search

sheharyarn / cloudup.dev

Tools to jump-start development on the Cloud ☁️
https://cloudup.dev
106 stars 11 forks source link

Ensure Dockerfile Consistency and Refine README for Professional Presentation #34

Closed devv-abubakar closed 8 months ago

devv-abubakar commented 8 months ago

Enhance Dockerfile: This update ensures Dockerfile consistency by replacing @{APP_NAME} with the standard Docker syntax ${APP_NAME}, aligning with community practices for uniformity.

Why these Changes?

In Dockerfiles, ${VAR_NAME} is widely adopted for referencing environment variables and improves readability and maintainability. To align with conventions, I've consistently used ${APP_NAME} instead of @{APP_NAME}, fostering clarity and supporting collaborative development.

While Docker may tolerate both syntaxes, adopting a standardized approach enhances code quality, reduces issues, and facilitates better collaboration within the development community.

These changes aim to improve readability, maintainability, and adherence to Dockerfile best practices.

README: This pull request refines the project's README to present a more professional and engaging overview. The changes include improved language, refined formatting, and enhanced clarity in the project's description.

sheharyarn commented 8 months ago

Thank you for sending a PR! 🌟

Please see my comment here regarding our custom variable substitution strategy, so we do actually need both variables in the ${VAR} and @{VAR} format.

Please revert these changes, and send your updated PR with the remaining changes so we can review it.