docs: Revise public profile README to list repositories and delivery … - #5
Merged
Conversation
…priorities, and clarify .github repo purpose and structure.
📝 WalkthroughWalkthroughAktualizace dvou dokumentačních souborů: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates SQLoot’s public organization profile and .github repository README to present a clearer, more current overview of the project, highlight public repositories, and streamline contributor/security guidance.
Changes:
- Refines the profile summary and replaces roadmap-style content with concise 2026 delivery priorities.
- Adds a “Public Repositories” table linking to key SQLoot repos with purpose and current focus.
- Expands the root
README.mdto document the purpose, structure, and operating rules of this org-health repository.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| profile/README.md | Rewrites the public-facing profile narrative; adds repo table and 2026 priorities; simplifies contributing/security links. |
| README.md | Replaces placeholder text with a clear description of what this .github repo contains and how it should be maintained. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
profile/README.md (1)
13-13: Opravte formátování textu v badge.Text badge "Bun-first-v1.3.10" vypadá nesprávně naformátovaný. Mělo by to být buď "Bun-first v1.3.10" (s mezerou), "Bun v1.3.10", nebo "Bun-first | v1.3.10" pro lepší čitelnost. Současná forma mísí název a verzi bez jasného oddělení.
💅 Navrhovaná oprava formátování badge
- <img src="/api/public/proxy/img.shields.io/badge/Bun-first-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" /> + <img src="/api/public/proxy/img.shields.io/badge/Bun_first-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" />Nebo alternativně:
- <img src="/api/public/proxy/img.shields.io/badge/Bun-first-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" /> + <img src="/api/public/proxy/img.shields.io/badge/Bun-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun runtime" />🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@profile/README.md` at line 13, Opravte formátování textu badge v elementu <img> v README.md: upravte část štítku v URL (aktuálně "Bun-first-v1.3.10-111827") a alt text tak, aby mezi názvem a verzí byla jasná mezera nebo oddělovač (např. "Bun-first v1.3.10", "Bun v1.3.10" nebo "Bun-first | v1.3.10"); pokud používáte spaces nebo pipe, správně je URL-encodeujte (např. space → %20 nebo použijte `%7C` pro |) a aktualizujte alt atribut odpovídajícím textem, aby štítek a alt byly konzistentní s novým formátem.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@profile/README.md`:
- Around line 30-35: Tabulka v README obsahuje pět nefunkčních odkazů
(bench-suite, relays, website, sqloot.github.io, awesome-local-first) které
vracejí 404; upravte ji tak, že buď opravíte URL na existující repozitáře nebo
odeberete řádky pro `bench-suite`, `relays`, `website`, `sqloot.github.io` a
`awesome-local-first`, ponecháte pouze fungující odkaz `evolu-plan-b` nebo
nahradíte nefunkční položky poznámkou „odstraněno/není dostupné“; ověřte změny
otevřením každého odkazu (kliknutím) a commitem aktualizovaného README.
In `@README.md`:
- Around line 17-29: The ASCII tree under the README that shows `.github/` is
inaccurate; update the ASCII diagram (the block containing `.github/` and its
subentries) to reflect the repository's real `.github` contents (it currently
only contains `dependabot.yml`) by removing the listed subfolders and files
(ISSUE_TEMPLATE/, workflow-templates/, profile/, CODEOWNERS, CODE_OF_CONDUCT.md,
CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, SECURITY.md, SUPPORT.md) and
replacing them with the actual entry `dependabot.yml` (or any other real items
if present) so the README's tree matches the repo.
---
Nitpick comments:
In `@profile/README.md`:
- Line 13: Opravte formátování textu badge v elementu <img> v README.md: upravte
část štítku v URL (aktuálně "Bun-first-v1.3.10-111827") a alt text tak, aby mezi
názvem a verzí byla jasná mezera nebo oddělovač (např. "Bun-first v1.3.10", "Bun
v1.3.10" nebo "Bun-first | v1.3.10"); pokud používáte spaces nebo pipe, správně
je URL-encodeujte (např. space → %20 nebo použijte `%7C` pro |) a aktualizujte
alt atribut odpovídajícím textem, aby štítek a alt byly konzistentní s novým
formátem.
Comment on lines
+17
to
+29
| ```text | ||
| .github/ | ||
| ├── ISSUE_TEMPLATE/ | ||
| ├── workflow-templates/ | ||
| ├── profile/ | ||
| │ └── README.md | ||
| ├── CODEOWNERS | ||
| ├── CODE_OF_CONDUCT.md | ||
| ├── CONTRIBUTING.md | ||
| ├── PULL_REQUEST_TEMPLATE.md | ||
| ├── SECURITY.md | ||
| └── SUPPORT.md | ||
| ``` |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Ověření struktury .github/ adresáře
echo "=== Kontrola existence .github/ adresáře ==="
if [ -d ".github" ]; then
echo "✓ .github adresář existuje"
else
echo "✗ .github adresář neexistuje"
exit 1
fi
echo ""
echo "=== Kontrola podadresářů ==="
for dir in "ISSUE_TEMPLATE" "workflow-templates" "profile"; do
if [ -d ".github/$dir" ]; then
echo "✓ .github/$dir existuje"
else
echo "✗ .github/$dir chybí"
fi
done
echo ""
echo "=== Kontrola souborů v .github/ ==="
for file in "CODEOWNERS" "CODE_OF_CONDUCT.md" "CONTRIBUTING.md" "PULL_REQUEST_TEMPLATE.md" "SECURITY.md" "SUPPORT.md"; do
if [ -f ".github/$file" ]; then
echo "✓ .github/$file existuje"
else
echo "✗ .github/$file chybí"
fi
done
echo ""
echo "=== Kontrola profile/README.md ==="
if [ -f ".github/profile/README.md" ]; then
echo "✓ .github/profile/README.md existuje"
else
echo "✗ .github/profile/README.md chybí"
fi
echo ""
echo "=== Skutečná stromová struktura .github/ ==="
tree .github -a --charset ascii 2>/dev/null || find .github -type f -o -type d | sort | sed 's|^\./||' | sed 's|[^/]*/| |g'Repository: SQLoot/.github
Length of output: 640
Struktura souborů v ASCII stromu neodpovídá skutečnosti.
ASCII strom v řádcích 17-29 dokumentuje strukturu, která v repozitáři neexistuje. Adresář .github/ obsahuje pouze dependabot.yml, všechny uvedené podadresáře (ISSUE_TEMPLATE/, workflow-templates/, profile/) a soubory (CODEOWNERS, CODE_OF_CONDUCT.md, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, SECURITY.md, SUPPORT.md) chybí. Opravte ASCII strom tak, aby odpovídal skutečné struktuře repozitáře.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 17 - 29, The ASCII tree under the README that shows
`.github/` is inaccurate; update the ASCII diagram (the block containing
`.github/` and its subentries) to reflect the repository's real `.github`
contents (it currently only contains `dependabot.yml`) by removing the listed
subfolders and files (ISSUE_TEMPLATE/, workflow-templates/, profile/,
CODEOWNERS, CODE_OF_CONDUCT.md, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md,
SECURITY.md, SUPPORT.md) and replacing them with the actual entry
`dependabot.yml` (or any other real items if present) so the README's tree
matches the repo.
…README with new configuration files.
There was a problem hiding this comment.
🧹 Nitpick comments (2)
README.md (1)
7-14: Sjednoťte „Purpose“ a stromovou strukturu, aby se dokumentace nerozjížděla.V „Purpose“ chybí položky, které jsou ve stromu (
.github/dependabot.yml,FUNDING.yml). Není to bug, ale dlouhodobě to zvyšuje riziko zastarání README.📝 Návrh úpravy
This repository defines public defaults used across SQLoot repositories: - community policy files (`CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, `SUPPORT.md`) - issue and pull request templates - workflow templates for new repositories - organization profile content (`profile/README.md`) - shared ownership baseline (`CODEOWNERS`) +- dependency update policy (`.github/dependabot.yml`) +- sponsorship metadata (`FUNDING.yml`)Also applies to: 19-31
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 7 - 14, Slučte obsah sekce "Purpose" s ukázkovou stromovou strukturou v README tak, aby obě části byly konzistentní: přidejte chybějící položky .github/dependabot.yml a FUNDING.yml do odstavce "Purpose" a upravte seznam položek tak, aby přesně odpovídal stromu (např. community policy files, issue/pull request templates, workflow templates, profile/README.md, CODEOWNERS, .github/dependabot.yml, FUNDING.yml); zajistěte, že jakákoli budoucí změna ve stromu se promítne do jedné sjednocené sekce, nikoli do dvou oddělených míst (upravit text v README v sekci Purpose a odstranit duplicitu nebo odkazy na samostatný strom tak, aby zůstal jediný zdroj pravdy).profile/README.md (1)
26-35: Zvažte přesnější název sekce místo „Repository Links“.Většina řádků už není odkaz, ale stav dostupnosti. Přesnější nadpis (např. „Repository Status“) by lépe odpovídal obsahu.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@profile/README.md` around lines 26 - 35, The section header "Repository Links" is misleading because many entries are no longer links; change the header text to a more accurate title such as "Repository Status" or "Repository Availability" and update any related captions/intro lines accordingly; locate the heading string "Repository Links" in the README and replace it with the chosen title and, if present, adjust the table column header "Link status" to remain consistent with the new section title.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@profile/README.md`:
- Around line 26-35: The section header "Repository Links" is misleading because
many entries are no longer links; change the header text to a more accurate
title such as "Repository Status" or "Repository Availability" and update any
related captions/intro lines accordingly; locate the heading string "Repository
Links" in the README and replace it with the chosen title and, if present,
adjust the table column header "Link status" to remain consistent with the new
section title.
In `@README.md`:
- Around line 7-14: Slučte obsah sekce "Purpose" s ukázkovou stromovou
strukturou v README tak, aby obě části byly konzistentní: přidejte chybějící
položky .github/dependabot.yml a FUNDING.yml do odstavce "Purpose" a upravte
seznam položek tak, aby přesně odpovídal stromu (např. community policy files,
issue/pull request templates, workflow templates, profile/README.md, CODEOWNERS,
.github/dependabot.yml, FUNDING.yml); zajistěte, že jakákoli budoucí změna ve
stromu se promítne do jedné sjednocené sekce, nikoli do dvou oddělených míst
(upravit text v README v sekci Purpose a odstranit duplicitu nebo odkazy na
samostatný strom tak, aby zůstal jediný zdroj pravdy).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
profile/README.mdto provide a clearer and more focused project overview, reorganize repository information, and clarify current priorities and contribution guidelines. The changes improve readability, update outdated information, and make it easier for new contributors and users to understand the project's direction.Project overview and priorities:
Repository organization:
Documentation and contribution guidance:
Summary by CodeRabbit
Poznámky k vydání
.github“ s rozšířeným obsahem a diagramem struktury.