Skip to content

DOC Make the README community-focused and easier to explore - #3820

Merged
Roman Lutz (romanlutz) merged 5 commits into
microsoft:mainfrom
romanlutz:romanlutz-github-growth-recommendations
Nov 3, 2026
Merged

Roman Lutz (romanlutz) merged 5 commits into
microsoft:mainfrom
romanlutz:romanlutz-github-growth-recommendations

Conversation

@romanlutz

Copy link
Copy Markdown
Contributor

Description

Make the README a concise introduction and community entry point, while keeping setup instructions and detailed guides on the website.

  • Explain the scanner, CoPyRIT GUI, and Python framework, with direct links to their website guides.
  • Put community participation and contribution opportunities in the opening, with automatically updated contributor, merged-PR, and closed-issue badges directly below the title.
  • Highlight Discord and the whitepaper, and separate research/citation information from trademark notices.
  • List supported model providers and link to provider setup, optional LiteLLM integrations, and HTTP, WebSocket, Playwright, and custom targets.

Only README.md changes. The website FAQ is separate work and is not included here.

Tests and Documentation

  • git diff --check origin/main...HEAD: passed.
  • Commit-time pre-commit hooks: passed for applicable hooks; code/notebook-specific checks were skipped where no files matched.
  • Checked the actual GitHub Markdown rendering and verified the badge endpoints and linked website guides.
  • Unit tests, documentation builds, and JupyText execution were not run because this is a root-README-only change with no executable examples or website-source changes.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Highlight the scanner, GUI, and framework with website links; promote Discord, contribution opportunities, and the whitepaper alongside activity badges.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 2, 2026 08:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for this documentation-only README update.

No open issues 🎉

What changed in this PR

This documentation-only PR makes the README a community-focused introduction to PyRIT, directing users to website guides for setup and detailed usage.

Changes:

  • Highlights community participation, contribution opportunities, and activity badges.
  • Introduces the scanner, CoPyRIT GUI, Python framework, and supported provider integrations.
  • Organizes research, citation, security, and trademark information into separate sections.
File Description
README.md Reorganizes the project introduction around community participation, toolkit discovery, and links to detailed guides.

Review effort: Balanced

@romanlutz

Copy link
Copy Markdown
Contributor Author

Screenshots of the actual GitHub rendering: the title and activity badges, community invitation, website navigation, and model/provider support.

README title with activity badges and community participation links

README navigation, supported model providers, and application targets

@romanlutz
Roman Lutz (romanlutz) added this pull request to the merge queue Nov 3, 2026
Merged via the queue into microsoft:main with commit eba98c1 Nov 3, 2026
68 of 70 checks passed
@romanlutz
Roman Lutz (romanlutz) deleted the romanlutz-github-growth-recommendations branch November 3, 2026 07:32
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.

3 participants