Skip to content

Conversation

@trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Dec 14, 2025

📔 Objective

Adds a section in Contributing Docs that lists all READMEs in a configured list of public repositories, as well as a script to run weekly that keeps them in sync.

A possible improvement to this would be to detect a new README in a PR and reactively create a PR to update this page.

The intent is to aid in discoverability of the READMEs for both internal and external contributors.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@trmartin4 trmartin4 changed the title Add-readmes-to-docs Add discoverability of code READMEs Dec 14, 2025
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 14, 2025

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 468ca54
Status: ✅  Deploy successful!
Preview URL: https://55c9e55c.contributing-docs.pages.dev
Branch Preview URL: https://add-readmes-to-docs.contributing-docs.pages.dev

View logs

@github-actions
Copy link
Contributor

github-actions bot commented Dec 14, 2025

Logo
Checkmarx One – Scan Summary & Details56b7486a-a7f4-4a9b-bc2b-09b3dec3d280

Great job! No new security vulnerabilities introduced in this pull request

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.

2 participants