Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<p>This is the bmwalters fork of Bun which enables running codegen scripts and bootstrapping an initial binary using node + npm + esbuild. See [here](https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic) for the list of changes.</p>

Comment on lines +1 to +2
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# Check the actual README.md file content at the beginning
head -20 README.md

Repository: oven-sh/bun

Length of output: 1223


🏁 Script executed:

# Look for linting configuration files
find . -maxdepth 2 -type f \( -name ".markdownlintrc*" -o -name "markdownlint.config.*" -o -name ".lintstagedrc*" -o -name ".prettier*" \) | head -20

Repository: oven-sh/bun

Length of output: 109


🌐 Web query:

Is https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic a valid GitHub repository URL?

💡 Result:

Yes — that URL is valid. It points to the commits page for the branch "codegen-runtime-agnostic" in the bmwalters/bun repository on GitHub. [1]

Source:
[1] GitHub — bmwalters/bun — Commits (branch: codegen-runtime-agnostic).


Remove or move the introductory HTML paragraph—file should not start with <p> tag.

The file begins with an HTML <p> tag instead of a proper markdown heading or content. While the fork information is helpful, it should either be converted to markdown format or moved below the main # Bun heading. The GitHub URL is valid and reachable.

Suggested fix

Option 1: Move below the main heading and convert to markdown

Remove lines 1-2, then add after the <h1 align="center">Bun</h1> heading:

+> **Note:** This is the bmwalters fork of Bun. It enables running codegen scripts and bootstrapping an initial binary using node + npm + esbuild. See the [codegen-runtime-agnostic branch](https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic) for the list of changes.

Option 2: Convert to markdown heading

-<p>This is the bmwalters fork of Bun which enables running codegen scripts and bootstrapping an initial binary using node + npm + esbuild. See [here](https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic) for the list of changes.</p>
+## About This Fork
+
+This fork enables running codegen scripts and bootstrapping an initial binary using node + npm + esbuild. See the [codegen-runtime-agnostic branch](https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic) for the list of changes.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<p>This is the bmwalters fork of Bun which enables running codegen scripts and bootstrapping an initial binary using node + npm + esbuild. See [here](https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic) for the list of changes.</p>
## About This Fork
This fork enables running codegen scripts and bootstrapping an initial binary using node + npm + esbuild. See the [codegen-runtime-agnostic branch](https://github.com/bmwalters/bun/commits/codegen-runtime-agnostic) for the list of changes.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🤖 Prompt for AI Agents
In README.md around lines 1 to 2, the file starts with an HTML <p> tag that
should be removed or relocated; delete the leading <p>…</p> block and either
convert its contents to markdown (e.g., a short paragraph or subheading and the
link) and place it appropriately (for example immediately after the main "# Bun"
heading) or move it below the primary title as plain markdown; ensure no raw
HTML remains at the top and that the fork description is formatted as standard
markdown text with the link preserved.

<p align="center">
<a href="https://bun.com"><img src="https://github.com/user-attachments/assets/50282090-adfd-4ddb-9e27-c30753c6b161" alt="Logo" height=170></a>
</p>
Expand Down