Skip to content

docs(readme): bring README in line with the readme documentation rule - #442

Merged
dnyw4l3n13 merged 2 commits into
mainfrom
docs/432-readme-rule
Oct 30, 2026
Merged

dnyw4l3n13 merged 2 commits into
mainfrom
docs/432-readme-rule

Conversation

@dnyw4l3n13

Copy link
Copy Markdown
Collaborator

Summary

Bring the repository README in line with the readme documentation rule.

Closes #432

@dnyw4l3n13 dnyw4l3n13 self-assigned this Oct 30, 2026
@credfeto

Copy link
Copy Markdown
Member

Roslyn analyzer findings

Source Rule Level File Line Suppressed Message
DotNet CA2000 error src/BuildBot/Helpers/ServerStartup.cs 99 yes Call System.IDisposable.Dispose on object created by 'CreateLogger()' before all references to it are out of scope

@dnyw4l3n13 dnyw4l3n13 added AI-Work Work for an AI Agent Low Low Priority labels Oct 30, 2026
@dnyw4l3n13

Copy link
Copy Markdown
Collaborator Author

Development: README.md rewritten to the readme documentation rule (required section order, reference-style links; Contributing/Security omitted per issue answer) in c1bf7c9. CI will run; next phase is Simplify once green.

@dnyw4l3n13

Copy link
Copy Markdown
Collaborator Author

Simplify clean - advancing to code review

@dnyw4l3n13

Copy link
Copy Markdown
Collaborator Author

Code review clean - advancing to security review

@dnyw4l3n13

Copy link
Copy Markdown
Collaborator Author

Security review clean (docs-only diff: README.md and CHANGELOG.md, no code or config changes), advancing to coverage check

@dnyw4l3n13

Copy link
Copy Markdown
Collaborator Author

Coverage ratchet passed (docs-only diff, no measurement needed) - advancing to Human Review

@dnyw4l3n13
dnyw4l3n13 marked this pull request as ready for review October 30, 2026 18:16
@dnyw4l3n13
dnyw4l3n13 requested a review from a team as a code owner October 30, 2026 18:16
@dnyw4l3n13
dnyw4l3n13 enabled auto-merge October 30, 2026 18:16
@dnyw4l3n13

Copy link
Copy Markdown
Collaborator Author

Finalize: PR marked ready and auto-merge enabled.

@credfeto

Copy link
Copy Markdown
Member

Super-linter summary

Language Validation result

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@dnyw4l3n13
dnyw4l3n13 merged commit cc9f0f6 into main Oct 30, 2026
41 checks passed
@dnyw4l3n13
dnyw4l3n13 deleted the docs/432-readme-rule branch October 30, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-Work Work for an AI Agent Low Low Priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): bring README in line with the readme documentation rule

2 participants