Skip to content

docs: standardize README and community files - #5

Merged
hectorvent merged 1 commit into
mainfrom
docs/standardize-readme
Oct 6, 2026
Merged

hectorvent merged 1 commit into
mainfrom
docs/standardize-readme

Conversation

@hectorvent

Copy link
Copy Markdown
Contributor

What

Part of a family-wide docs alignment across the five Floci Testcontainers modules.

  • README rewritten to the layout now shared by all five Floci Testcontainers modules: the org-profile Floci logo header (light and dark), a fixed section order, an emulator table with a Supported column (AWS supported here; Azure, GCP and OCI planned), links to the other language modules, and the trademark footer. All existing technical content is kept, moved under the matching sections.
  • No drifting numbers in docs: service counts, startup and size claims, and pinned Floci versions in examples are gone; the service list links to the Floci docs instead.
  • Community files match the rest of the org (modeled on floci-aws): CODE_OF_CONDUCT.md and SECURITY.md (private vulnerability reporting for this repo); CONTRIBUTING.md gains the Slack link, the DCO sign-off section, the no-AI-attribution rule and a security section, keeping its repo-specific build and test guidance.
  • LICENSE copyright holder is now Floci and its contributors, the same line as every other Floci repo.
  • .gitignore ignores the root /local/ scratch directory.
  • Adds CODE_OF_CONDUCT.md, SECURITY.md and .github/CODEOWNERS.
  • Fixes the CI lint job on main: ruff 0.16 formats Python code blocks inside Markdown, and ruff format --check . was failing on README.md. The README code blocks are now ruff-formatted. (ruff>=0.4 is still unbounded, so a future ruff can do this again; bounding it is left for a separate change.)
  • Drops the localstack keyword from pyproject.toml.

Why

The five module READMEs and community files had drifted apart (different headers and section order, hardcoded service counts that were already wrong, missing SECURITY/CODE_OF_CONDUCT, four different LICENSE copyright lines). They now present as one family and link to each other.

Area

Docs and repo hygiene only. No library code changes.

Tests

ruff check ., ruff format --check ., mypy floci and pytest -m "not integration" pass on Linux (Python 3.11, ruff 0.16.10).

Refs

No issue; family-wide consistency change.

@greptile-apps

greptile-apps Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low risk] Standardizes documentation and community governance files.

The PR appears safe to merge; the previous finding is fixed and no new actionable issues remain.

Summary

This PR aligns the README and community files with the other Floci modules.

  • Standardizes the README layout, service links, container options, and language links.
  • Adds community policies and code owners, updates the license holder, and removes the localstack keyword.
  • Fixes the previous finding by using uv run for contributor checks and explaining the pip alternative.
  • No new actionable issues were found.
  • The requested greptile_confidence label could not be added because GitHub authentication was unavailable.

Reviews (2) · Last reviewed commit: "docs: standardize README and community f..."

Comment thread README.md Outdated
- README: family layout shared by all five Testcontainers modules (org-profile
  Floci logo header, fixed section order, emulator table with a Supported column,
  links to the other language modules, trademark footer)
- Remove drifting numbers from docs: service counts, timing and size claims,
  pinned Floci versions in examples
- CODE_OF_CONDUCT and SECURITY aligned with floci-aws; SECURITY points at this
  repo's private vulnerability reporting
- CONTRIBUTING: Slack link, DCO sign-off section, no-AI-attribution rule and a
  security section, keeping the repo-specific build and test guidance
- LICENSE copyright holder: Floci and its contributors
- Ignore the root /local/ scratch directory
- Add CODE_OF_CONDUCT.md, SECURITY.md and .github/CODEOWNERS
- Format README code blocks with ruff: ruff 0.16 formats Markdown code blocks,
  which made ruff format --check fail on main
- README and CONTRIBUTING run the dev tools through uv run, so they work after
  uv sync without activating the virtualenv
- Drop the localstack package keyword

Signed-off-by: Hector Ventura <hectorvent@gmail.com>
@hectorvent
hectorvent force-pushed the docs/standardize-readme branch from c104c8b to 3d7bfc3 Compare October 6, 2026 22:27
@hectorvent
hectorvent merged commit bd9678c into main Oct 6, 2026
7 of 8 checks passed
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