-
Notifications
You must be signed in to change notification settings - Fork 114
A Detailed Documentation for Leaderboard Creation #660
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-Authored-By: Sanjay Viswanathan <[email protected]>
@Adez017 is attempting to deploy a commit to the recode Team on Vercel. A member of the Team first needs to authorize it. |
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. The estimated time for response is 5–8 hrs. In the meantime, please provide all necessary screenshots and make sure you run - npm build run , command and provide a screenshot, a video recording, or an image of the update you made below, which helps speed up the review and assignment. If you have questions, reach out to LinkedIn. Your contributions are highly appreciated!😊 Note: I maintain the repo issue every day twice at 8:00 AM IST and 9:00 PM IST. If your PR goes stale for more than one day, you can tag and comment on this same issue by tagging @sanjay-kv. We are here to help you on this journey of open source. Consistent 20 contributions are eligible for sponsorship 💰 🎁 check our list of amazing people we sponsored so far: GitHub Sponsorship. ✨ 📚Your perks for contribution to this community 👇🏻
If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊 |
Synced data from Linked IssuesLabels:
Assignees:
Milestones:
|
Hi @sanjay-kv , i had created the file for the documentation in the main (root ) folder as discussed we can move it to wiki page from your end . take a look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for the GitHub organization leaderboard implementation at Recode Hive. The documentation covers the complete architecture, data flow, API usage, caching strategies, and implementation details of a leaderboard that tracks merged pull requests across all repositories in a GitHub organization.
- Detailed technical documentation explaining the leaderboard's multi-stage data collection process
- Comprehensive GitHub API reference with examples and error handling strategies
- Performance optimization techniques including batching, caching, and memoization approaches
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Documentation.md
Outdated
|
||
Request Example: | ||
bashcurl -H "Authorization: token YOUR_TOKEN" \ |
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing code block syntax. Should be ```bash at the beginning of line 500.
Request Example: | |
bashcurl -H "Authorization: token YOUR_TOKEN" \ | |
```bash | |
curl -H "Authorization: token YOUR_TOKEN" \ | |
-H "Accept: application/vnd.github.v3+json" \ | |
"https://api.github.com/repos/recodehive/awesome-project/pulls?state=closed&per_page=100&page=1" |
Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 6 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
}; | ||
Computed Contributors | ||
This is where React's useMemo shines: | ||
typescriptconst contributors = useMemo(() => { |
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing code block formatting. The text 'typescriptconst' should be properly formatted as a code block with language identifier.
Copilot uses AI. Check for mistakes.
"https://api.github.com/repos/recodehive/awesome-project/pulls?state=closed&per_page=100&page=1" | ||
|
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing newline between 'json' and '['. Should be '```json' on one line and '[' on the next line.
Copilot uses AI. Check for mistakes.
```bash | ||
curl -H "Authorization: token YOUR_TOKEN" \ | ||
-H "Accept: application/vnd.github.v3+json" \ |
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing code block formatting. Should be '```bash' with proper newline before the curl command.
```bash | |
curl -H "Authorization: token YOUR_TOKEN" \ | |
-H "Accept: application/vnd.github.v3+json" \ | |
```bash | |
curl -H "Authorization: token YOUR_TOKEN" \ | |
-H "Accept: application/vnd.github.v3+json" \ | |
"https://api.github.com/repos/recodehive/awesome-project/pulls?state=closed&per_page=100&page=1" |
Copilot uses AI. Check for mistakes.
```bash | ||
curl -H "Authorization: token YOUR_TOKEN" \ | ||
-H "Accept: application/vnd.github.v3+json" \ |
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing code block formatting. Should be '```bash' with proper newline before the curl command.
```bash | |
curl -H "Authorization: token YOUR_TOKEN" \ | |
-H "Accept: application/vnd.github.v3+json" \ | |
```bash | |
curl -H "Authorization: token YOUR_TOKEN" \ | |
-H "Accept: application/vnd.github.v3+json" \ | |
"https://api.github.com/orgs/recodehive" |
Copilot uses AI. Check for mistakes.
All requests require a GitHub Personal Access Token: | ||
```typescript | ||
const headers: Record<string, string> = { | ||
Authorization: `token ${YOUR_GITHUB_TOKEN}`, |
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing code block formatting. Should be '```typescript' with proper newline before the const declaration.
All requests require a GitHub Personal Access Token: | |
```typescript | |
const headers: Record<string, string> = { | |
Authorization: `token ${YOUR_GITHUB_TOKEN}`, | |
```typescript | |
const headers: Record<string, string> = { | |
Authorization: `token ${YOUR_GITHUB_TOKEN}`, | |
Accept: "application/vnd.github.v3+json", | |
}; |
Copilot uses AI. Check for mistakes.
(currentPage - 1) * itemsPerPage, | ||
currentPage * itemsPerPage | ||
); | ||
|
Copilot
AI
Oct 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing space between language identifier and code. Should be '```tsx' with proper newline before the code content.
Copilot uses AI. Check for mistakes.
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@Adez017 can u pull and push again, i made some package changes. |
Ol @sanjay-kv , will close this pr and open a fresh new |
@sanjay-kv check this out now |
Description
This is a detail documentation with all the things needed to understand the architecture and working for the leaderboard we created for the dashboard
Fixes #528
Type of Change
Changes Made
Dependencies
Checklist
npm run build
and attached screenshot(s) in this PR.