Skip to content
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 Dockerfile: Added Comments to briefly explain the instructions. #2683

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Piyush-r-bhaskar
Copy link

What should this PR do?

Explains the purpose and functionality of each instructions.

Why are we making this change?

Dockerfiles can become complex, especially with multi-stage builds and intricate instructions. Comments help explain the purpose and functionality of each instructions, making it easier for others (and your future self) to understand what each step does.

Commented Dockerfiles act as living documentation. They help teammates comprehend the build process, encouraging collaboration and reducing the chances of errors.

Copy link

sourcery-ai bot commented Oct 21, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have skipped reviewing this pull request. We don't review packaging changes - Let us know if you'd like us to change this.

# - python3, make, g++: Essential build tools for various dependencies.
# - py3-pip: Package installer for Python 3.
RUN apk update && \
apk add --no-cache libc6-compat python3 make g++ py3-pip && \

Check notice

Code scanning / SonarCloud

Arguments in long RUN instructions should be sorted Low

Sort these package names alphanumerically. See more on SonarCloud
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant