Add metrics #2
Closed
Add metrics #2
Conversation
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
|
NIT: Should we have an extra level to separate scripts about OWD metrics and those about MDN metrics (that we don't have yet, but I can see us creating)? Like |
Elchi3
reviewed
Apr 6, 2022
There was a problem hiding this comment.
My spell checker wants en-US! 😄
This looks good to me overall. I think you probably updated this already a bit to take into account BCD and to add the other orgs? If you push that here and maybe send around the fetched data, then I'm happy to test this on my machine, too.
| @@ -0,0 +1,25 @@ | |||
| This directory contains some scripts and data for generating metrics about the work of Open Web Docs. | |||
|
|
|||
| It's got three subdirectories: *query*, *data*, and *analyse*. | |||
There was a problem hiding this comment.
Suggested change
| It's got three subdirectories: *query*, *data*, and *analyse*. | |
| It's got three subdirectories: *query*, *data*, and *analyze*. |
| node query-prs.js MY-TOKEN-HERE | ||
| ``` | ||
|
|
||
| It's (obviously) advisable not to run this again and again, but to run it once, then analyse the results at your leisure. |
There was a problem hiding this comment.
Suggested change
| It's (obviously) advisable not to run this again and again, but to run it once, then analyse the results at your leisure. | |
| It's (obviously) advisable not to run this again and again, but to run it once, then analyze the results at your leisure. |
|
|
||
| The "organizations.json" file contains an object each of whose keys represents an organization. The key is the organization name. Each organization object lists the GitHub usernames for people in that organization for each month we are interested in. | ||
|
|
||
| ## analyse |
There was a problem hiding this comment.
Suggested change
| ## analyse | |
| ## analyze |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I would like us to get better at generating metrics for our activity. So I've filed this PR, that adds a couple of Node scripts.
The first one uses GitHub's API to fetch all PRs filed to mdn/content.
The second one uses that, and another file called "organizations.json", to work out, for each month, how many PRs were filed by members of a particular organization in each month. For example, it's currently hardcoded to use the "owd" org, so running it would give us:
...which is the number of PRs filed by OWD staff in each month. Obviously with different orgs we can compare.
I'm filing this here for a couple of reasons:
As you can see it's very rough at the moment (e.g. org being hardcoded to "owd"). But ready for feedback I think
(and usable now).