feat: add script to build contributors.md#639
Merged
mcdurdin merged 2 commits intokeymanapp:masterfrom Jan 18, 2026
Merged
Conversation
Test-bot: skip
User Test ResultsTest specification and instructions User tests are not required |
mcdurdin
requested changes
Jan 17, 2026
Member
mcdurdin
left a comment
mcdurdin
left a comment
There was a problem hiding this comment.
Looks great! A few small changes requested. Can you also add jsdoc comments for significant functions and standard Keyman copyright header?
| program.parse(process.argv); | ||
|
|
||
| async function main() { | ||
| // Header for the markdown file. Can include explaination, title, etc. |
Member
There was a problem hiding this comment.
Suggested change
| // Header for the markdown file. Can include explaination, title, etc. | |
| // Header for the markdown file. Can include explanation, title, etc. |
_scripts/contributors/crowdin.mjs
Outdated
| if (crowdata.data.status !== "finished") { | ||
| // Wait for the report to complete it's generation | ||
| console.log("Waiting"); | ||
| let cdc = await crowdin.reportsApi.checkReportStatus(386703, crowdata.data.identifier); |
Member
There was a problem hiding this comment.
Hard-coded values should be consts at top of file
_scripts/contributors/crowdin.mjs
Outdated
| } | ||
|
|
||
| export function genCrowdin(data) { | ||
| const MAJOR_CONTUBUTION_THRESHOLD = 1000; |
_scripts/contributors/crowdin.mjs
Outdated
| let major = []; | ||
| let minor = []; | ||
|
|
||
| // Mondify crowdin data to appear like the github data |
Member
There was a problem hiding this comment.
Suggested change
| // Mondify crowdin data to appear like the github data | |
| // Modify crowdin data to appear like the github data |
_scripts/contributors/github.mjs
Outdated
| }); | ||
|
|
||
| // Get a list of every repo in the keymanapp github organization | ||
| let allRepos = await getReposByOrg("keymanapp"); |
Member
There was a problem hiding this comment.
Const hard-coded values please
_scripts/contributors/github.mjs
Outdated
| } | ||
|
|
||
| export function genGithub(repo) { | ||
| const MAJOR_CONTUBUTION_THRESHOLD = 100; |
_scripts/contributors/github.mjs
Outdated
|
|
||
| async function getReposByOrg(org) { | ||
| // Fetch a list of all repositories belonging to this organization. | ||
| console.log("TODO: Github Api Pagination"); |
Member
There was a problem hiding this comment.
This needs to be fixed up? Octokit.paginate
_scripts/contributors/github.mjs
Outdated
|
|
||
| async function getAllRepos(allRepos) { | ||
| // Fetch the data for the given list of repositories. | ||
| console.log("TODO: Github Api Pagination"); |
| return repos.data.map(repo => repo.name); | ||
| } | ||
|
|
||
| async function getAllRepos(allRepos) { |
Member
There was a problem hiding this comment.
Could you rename this to make it clearer what it is doing?
Also adds initial contributors.md file
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
2 participants
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.
Test-bot: skip