Skip to content

Conversation

jjweston
Copy link

@jjweston jjweston commented Oct 5, 2025

Fix inconsistent indentation in ecosystem readme files which is causing the second code block to be indented in GitHub's Markdown renderer while the first is not. This is fixed by indenting the first code block using three spaces, matching the second code block.

Make the text formatting between the two list items consistent by adding a line break between the second list item and its corresponding code block. This does not affect how the file is rendered in GitHub's Markdown renderer, but it is an inconsistent text-formatting style between the two list items.

Remove trailing whitespace from two lines in the "docker" ecosystem readme file.

What are you trying to accomplish?

I am attempting to fix a visual inconsistency with how the ecosystem readme files are displayed on GitHub. In the readme file for many ecosystems the second code block is indented while the first is not. This appears to be caused by inconsistent indentation in the code blocks between the two list items. The first code block is indented with two spaces while the second is indented with three spaces. Increasing the indent of the first code block to match the indent of the second code block appears to fix the issue.

I also noticed inconsistent text formatting between the two list items. There is a line break between the first list item and its corresponding code block, but not between the second list item and its corresponding code block. I added a line break between the second list item and its corresponding code block.

My editor automatically removed trailing whitespace from two lines in the docker ecosystem readme file.

Anything you want to highlight for special attention from reviewers?

I can't think of anything to highlight for special attention. I did notice additional inconsistencies between different readme files (one example: some tag the code blocks with shell, some with bash, while most don't tag the code blocks at all). My focus was on the visual indentation of the two code blocks, so I fixed the indentation, added line break, and removed the trailing whitespace.

How will you know you've accomplished your goal?

I can view the readme files on my branch and fork and see that the indentation of the two code blocks is now consistent.

Checklist

  • I have run the complete test suite to ensure all tests and linters pass.
  • I have thoroughly tested my code changes to ensure they work as expected, including adding additional tests for new functionality.
  • I have written clear and descriptive commit messages.
  • I have provided a detailed description of the changes in the pull request, including the problem it addresses, how it fixes the problem, and any relevant details about the implementation.
  • I have ensured that the code is well-documented and easy to understand.

I have not added new code or updated existing code, so I have not attempted to run the complete test suite. I assume that readme files fall outside the scope of the complete test suite. Apologies if that is not the case, let me know and I'll run the complete test suite.

Fix inconsistent indentation in ecosystem readme files which is causing
the second code block to be indented in GitHub's Markdown renderer while
the first is not. This is fixed by indenting the first code block using
three spaces, matching the second code block.

Make the text formatting between the two list items consistent by adding
a line break between the second list item and its corresponding code
block. This does not affect how the file is rendered in GitHub's
Markdown renderer, but it is an inconsistent text-formatting style
between the two list items.

Remove trailing whitespace from two lines in the "docker" ecosystem
readme file.
@jjweston jjweston requested review from a team as code owners October 5, 2025 22:10
@github-actions github-actions bot added L: php:composer Issues and code for Composer L: ruby:bundler RubyGems via bundler L: elixir:hex Elixir packages via hex L: java:gradle Maven packages via Gradle L: go:modules Golang modules L: github:actions GitHub Actions L: elm Elm packages L: git:submodules Git submodules L: terraform Terraform packages L: docker Docker containers L: rust:cargo Rust crates via cargo L: dotnet:nuget NuGet packages via nuget or dotnet L: java:maven Maven packages via Maven L: dart:pub Dart packages via pub L: javascript L: python L: swift Swift packages L: devcontainers L: dotnet:dotnet-sdk L: docker:compose Docker Compose L: python:uv L: helm L: cpp:vcpkg L: rust:rust-toolchain labels Oct 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

L: cpp:vcpkg L: dart:pub Dart packages via pub L: devcontainers L: docker:compose Docker Compose L: docker Docker containers L: dotnet:dotnet-sdk L: dotnet:nuget NuGet packages via nuget or dotnet L: elixir:hex Elixir packages via hex L: elm Elm packages L: git:submodules Git submodules L: github:actions GitHub Actions L: go:modules Golang modules L: helm L: java:gradle Maven packages via Gradle L: java:maven Maven packages via Maven L: javascript L: php:composer Issues and code for Composer L: python:uv L: python L: ruby:bundler RubyGems via bundler L: rust:cargo Rust crates via cargo L: rust:rust-toolchain L: swift Swift packages L: terraform Terraform packages

2 participants