From 9cd1c0667fa57c9b06ad84138a42a0790039416f Mon Sep 17 00:00:00 2001 From: Gulsah Sarsilmaz Date: Sat, 2 May 2026 17:46:41 -0300 Subject: [PATCH] docs: standardize bullet style to hyphens (GH9742) Two files mixed asterisk and hyphen bullets: - README.md: 9 asterisk-bulleted dependency links in "Open Source Dependencies" alongside hyphen bullets elsewhere in the same file. - .github/pull_request_template.md: 5 asterisk-bulleted changelog suffix descriptions in the commented-out instructions, alongside hyphen bullets used in the visible Linked Issue checkboxes. Convert both to hyphens so every Markdown file in the repo's core docs (CODE_OF_CONDUCT.md, CONTRIBUTING.md, FAQ.md, README.md, SECURITY.md, WARP.md, .github/pull_request_template.md) uses the hyphen bullet style consistently. No content or wording changes. Verified post-edit: zero asterisk bullets remain in the seven core docs files; all bullets are hyphens. --- .github/pull_request_template.md | 10 +++++----- README.md | 18 +++++++++--------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3eab0afe5..9d86ab2c6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,11 +24,11 @@ How did you test this change? What automated tests did you add? If you didn't ad The entries below will be used when constructing a soft-copy of the stable release changelog. Leave blank or remove the lines if no entry in the stable changelog is needed. Entries should be on the same line, without the `{{` `}}` brackets. You can use multiple lines, even of the same type. The valid suffixes are: -* NEW-FEATURE: for new, relatively sizable features. Features listed here will likely have docs / social media posts / marketing launches associated with them, so use sparingly. -* IMPROVEMENT: for new functionality of existing features. -* BUG-FIX: for fixes related to known bugs or regressions. -* IMAGE: the image specified by the URL (hosted on GCP) will be added to Dev & Preview releases. For Stable releases, see the pinned doc in the #release Slack channel. -* OZ: Oz-related updates. Use `CHANGELOG-OZ`. At most 4 Oz updates are shown in-app per release. +- NEW-FEATURE: for new, relatively sizable features. Features listed here will likely have docs / social media posts / marketing launches associated with them, so use sparingly. +- IMPROVEMENT: for new functionality of existing features. +- BUG-FIX: for fixes related to known bugs or regressions. +- IMAGE: the image specified by the URL (hosted on GCP) will be added to Dev & Preview releases. For Stable releases, see the pinned doc in the #release Slack channel. +- OZ: Oz-related updates. Use `CHANGELOG-OZ`. At most 4 Oz updates are shown in-app per release. CHANGELOG-NEW-FEATURE: {{text goes here...}} CHANGELOG-IMPROVEMENT: {{text goes here...}} diff --git a/README.md b/README.md index ab2bec0a2..3bd9750b1 100644 --- a/README.md +++ b/README.md @@ -89,12 +89,12 @@ We ask everyone to be respectful and empathetic. Warp follows the [Code of Condu We'd like to call out a few of the [open source dependencies](https://docs.warp.dev/help/licenses) that have helped Warp to get off the ground: -* [Tokio](https://github.com/tokio-rs/tokio) -* [NuShell](https://github.com/nushell/nushell) -* [Fig Completion Specs](https://github.com/withfig/autocomplete) -* [Warp Server Framework](https://github.com/seanmonstar/warp) -* [Alacritty](https://github.com/alacritty/alacritty) -* [Hyper HTTP library](https://github.com/hyperium/hyper) -* [FontKit](https://github.com/servo/font-kit) -* [Core-foundation](https://github.com/servo/core-foundation-rs) -* [Smol](https://github.com/smol-rs/smol) +- [Tokio](https://github.com/tokio-rs/tokio) +- [NuShell](https://github.com/nushell/nushell) +- [Fig Completion Specs](https://github.com/withfig/autocomplete) +- [Warp Server Framework](https://github.com/seanmonstar/warp) +- [Alacritty](https://github.com/alacritty/alacritty) +- [Hyper HTTP library](https://github.com/hyperium/hyper) +- [FontKit](https://github.com/servo/font-kit) +- [Core-foundation](https://github.com/servo/core-foundation-rs) +- [Smol](https://github.com/smol-rs/smol)