docs: standardize bullet style to hyphens (GH9742)#9937
Open
gulsahsarsilmaz wants to merge 1 commit intowarpdotdev:masterfrom
Open
docs: standardize bullet style to hyphens (GH9742)#9937gulsahsarsilmaz wants to merge 1 commit intowarpdotdev:masterfrom
gulsahsarsilmaz wants to merge 1 commit intowarpdotdev:masterfrom
Conversation
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-actions
Bot
added
the
external-contributor
Contributor
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I reviewed this pull request and requested human review from: @warpdotdev/oss-maintainers. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Overview
This docs-only PR standardizes Markdown bullet markers from asterisks to hyphens in .github/pull_request_template.md and README.md without changing rendered content or repository behavior.
Concerns
- No blocking concerns found.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
oz-for-oss
Bot
requested review from
a team and
kevinchevalier
and removed request for
a team
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves the inconsistent bullet styling called out in #9742. Two files in the core docs were mixing asterisk (
*) and hyphen(
-) bullets within themselves, while every other top-level Markdown file in the repo already uses hyphens uniformly:README.md— the nine Open Source Dependencies entries used*while the rest of the file used-..github/pull_request_template.md— the fiveCHANGELOG-*suffix descriptions in the commented-out instruction block used*while the visible Linked Issue checkboxes used-.Both are now hyphens. After this PR every
.mdfile in the seven core docs (CODE_OF_CONDUCT.md,CONTRIBUTING.md,FAQ.md,README.md,SECURITY.md,WARP.md,.github/pull_request_template.md) uses the hyphen style consistently.The other items mentioned in #9742 (header spacing, section dividers) were spot-checked and are already consistent across these
files; no further changes were necessary. If a maintainer wants stricter project-wide enforcement (e.g. a
markdownlintconfig orprettier --parser markdownrun over the whole tree), that is a tooling decision that warrants its own discussion and a muchlarger diff — happy to follow up on a separate PR if there is interest.
Linked Issue
Closes #9742.
ready-to-specorready-to-implement.changes).
N/A — docs-only change; no UI or behavior impact.
Screenshots / Videos
N/A — docs-only.
Testing
Verified post-edit with
grep -c '^\* \|^ \* \|^ \* 'over the seven core.mdfiles; all return0asterisk-bulleted lines.No code changes; no test-suite impact.
Agent Mode