Transform GitHub Pull Requests into LLM-ready markdown effortlessly. By simply replacing github.com with gitcom.dev in any PR URL, users can fetch comments formatted with line numbers and token counts, ensuring a clear and structured output for easier analysis and review.
Gitcom.dev provides a powerful tool to transform GitHub Pull Requests into LLM-ready markdown. By simply replacing github.com with gitcom.dev in any Pull Request URL, users can obtain all comments formatted with line numbers and token counts, streamlining the review and analysis process.
Key Features
- Fetch All Comments: Retrieve all comments from a GitHub Pull Request effortlessly.
- Specific Comments: Access specific comments using their numbers to focus on the most relevant feedback.
- Parent Review Comments: Include the context of review comments (e.g., APPROVE, REQUEST_CHANGES) for deeper insights.
- Threaded Replies: Display comments and their replies in a structured, threaded format.
- Token Counting: Benefit from built-in tokenization to facilitate language model interactions.
- Clean Output: Receive a well-formatted markdown output that enhances readability.
- Performance Optimization: Developed with Bun for high performance and low latency.
Usage Examples
To start utilizing Gitcom.dev, replace the standard GitHub URL format with the Gitcom format:
Basic Usage:
# Original GitHub PR URL:
https://github.com/inboundemail/inbound/pull/142
# GitCom URL:
https://gitcom.dev/inboundemail/inbound/pull/142
To fetch a specific comment, simply append the comment number:
# Fetch the 5th comment
https://gitcom.dev/inboundemail/inbound/pull/142/5
API Requests
The API allows for various request formats, including:
- Get All Comments:
curl https://gitcom.dev/inboundemail/inbound/pull/142
- Get Specific Comment:
curl https://gitcom.dev/inboundemail/inbound/pull/142/5
Endpoint Format
GET /:repoOwner/:repoName/pull/:pullRequestNumber[/:commentNumber]
Path Parameters:
repoOwner: The owner of the GitHub repository (username or organization).repoName: Name of the repository.pullRequestNumber: Identifier number of the Pull Request.commentNumber(optional): Number of a specific comment to retrieve.
Query Parameters:
include_reviews=true: Optional flag to include parent review comments.show_threading=true: Optional flag to display replies in a threaded manner.resolved=true/false: Optional filter based on resolved status (subject to API limitations).
The response includes a comprehensive markdown format containing metadata for the Pull Request, the total token count, and detailed comment information. This data-rich output empowers users to analyze feedback and engage more effectively with code revisions.
For additional details on features, please refer to the FEATURES documentation.
Gitcom.dev enhances the efficiency of code reviewing processes, making it an essential tool for teams utilizing GitHub.
No comments yet.
Sign in to be the first to comment.