Skip to content

Polish open-source project presentation - #2

Merged
everettjf merged 1 commit into
mainfrom
agent/open-source-polish
Aug 1, 2026
Merged

Polish open-source project presentation#2
everettjf merged 1 commit into
mainfrom
agent/open-source-polish

Conversation

@everettjf

Copy link
Copy Markdown
Owner

What changed

  • redesign the English and Chinese README headers with the app icon, release/test/platform badges, product links, and full-width screenshot showcases
  • add a macOS core-test workflow for pushes and pull requests
  • add structured bug and feature issue forms, a pull request checklist, release-note categories, and code ownership
  • add contribution, support, security, and conduct policies

Why

The repository already has strong comparison correctness and performance work, but its public landing page and contributor workflow did not communicate that quality. These changes make the project easier to evaluate, build, test, contribute to, and report issues against.

Validation

  • bash macos/Tests/run-tests.sh — all 45 focused checks and 300 randomized shortest-edit-script cases passed
  • parsed every .github/**/*.yml file successfully
  • git diff --cached --check
  • visually inspected both 2560×1600 README screenshots

Note

A license is intentionally not included because the owner still needs to choose the legal terms (for example MIT or Apache-2.0).

@everettjf
everettjf marked this pull request as ready for review August 1, 2026 19:33
@everettjf
everettjf merged commit 90b0f2e into main Aug 1, 2026
1 check 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