Skip to content

Commit 05f951f

Browse files
authored
Update prioritization_response.md (#51)
* Fixups on prioritization_response.md * SLA tweaks * Link to prioritization_response.md
1 parent 5aef7e3 commit 05f951f

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed

community/prioritization_response.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
## Overview
22

3-
Given that we are a small functional team that is meant to maintain :wrench:, support ::phone::, care for :heart:, and cultivate :sunflower: our amazing Octokit :octocat: and Terraform community we often have to make decisions that are best for the entire community.
3+
Given that we are a small functional team that is meant to maintain :wrench:, support :phone:, care for :heart:, and cultivate :sunflower: our amazing Octokit :octocat: and Terraform community we often have to make decisions that are best for the entire community.
44
We don't take this act of prioritization lightly nor are we haphazard about it. We want to honor the time and thought that everyone has put into all of the SDKs that we have come to know and :heart:.
55

6-
Add that to the number of repos that we need to maintain (70+) and weekly interactions (500-1000 +/-) that we end up having with everyone I am sure it's clear why we have to define how we **prioritize** and our commitment to respond (think of an **SLA** of sorts) to those priorities.
6+
With the number of repos that we need to maintain (70+) and weekly interactions (500-1000 +/-) that we end up having with everyone, we have to define how we **prioritize** and our commitment to respond (think of an **SLA** of sorts) to those priorities.
77

88
### What are the Priorities?
99

10-
In each of the repositories we own you'll see the same [labels](https://github.com/octokit/octokit.net/labels) for priority.
10+
In each of the repositories we own you'll see the same [labels](https://github.com/octokit/octokit.net/labels) for priority.
1111

12-
**They are:**
12+
**They are:**
1313
`Priority: Critical`, `Priority: High`, `Priority: Normal`, `Priority: Low`
1414

15-
Incidentally, these map directly to the priorities set in our [Octokit Active community board](https://github.com/orgs/octokit/projects/10/views/4).
15+
These map directly to the priorities set in our [Octokit Active community board](https://github.com/orgs/octokit/projects/10/views/4).
1616

1717
| [Repo label](https://github.com/octokit/octokit.net/labels) | [Community board](https://github.com/orgs/octokit/projects/10/views/4) | Example |
1818
|----------|:-------------:|:-----------|
@@ -23,34 +23,34 @@ Incidentally, these map directly to the priorities set in our [Octokit Active co
2323

2424
### What are our response commitments?
2525

26-
Note: This does not represent a commitment to resolution, just how quickly we'll respond and begin working on it
26+
Note: This does not represent a commitment to resolution, just how quickly we'll acknowledge and respond.
2727

28-
| Priority | Response expectation |
28+
| Priority | Response expectation |
2929
|----------|:-----------|
30-
| Urgent | 0 to **24hrs**: A security advisory will be posted if needed and updates publically posted to the corresponding repository |
31-
| High | =< **1 Week** : Typically, we'll respond in issue/pr and will have a plan of action within the response expectation time window. |
32-
| Normal | >= **1 Week** : We'll acknowledge and make administrative assignments to the issue or PR. They might get labeled "up-for-grabs". |
33-
| Low | > **1 Week**: Typically, little to no action will take place on these items. They will often get labeled "up-for-grabs". |
30+
| Urgent | 0 to **24hrs**: A security advisory will be posted if needed and updates publically posted to the corresponding repository in issue or discussion form. |
31+
| High | <= **1 Week** : We'll respond in issue/PR and will have a plan of action within the response expectation time window. |
32+
| Normal | >= **1 Week** : We'll acknowledge and make administrative assignments to the issue or PR. It may be labeled "up-for-grabs", where we encourage community contribution. |
33+
| Low | > **1 Week**: Typically, little to no action will take place on these items. |
3434

3535

36-
### How do we Prioritize?
36+
### How do we prioritize?
3737

38-
Remembering that we as a team have to prioritize not at the individual SDK or community level but across many repositories and communities our, methods need to consider several variables.
38+
Remembering that we as a team have to prioritize not at the individual SDK or community level but across many repositories and communities, our methods need to consider several variables.
3939
Our process, while not exactly scientific, is aimed at protecting the interests of our communities first - we use a modified version of [RICE](https://www.productplan.com/glossary/rice-scoring-model/).
4040

4141
Here are some data points, empathetic aspects, and questions we use to help us prioritize.
4242

4343
* Does the issue compromise data integrity, user security, or the integrity of GitHub?
44-
* How serious is the need?
44+
* How serious is the need?
4545
* What's the overall impact on the SDK community?
46-
* What's the overall impact on the package communities
47-
* What's the overall impact on the language communities
46+
* What's the overall impact on the package communities?
47+
* What's the overall impact on the language communities?
4848
* How active is the SDK community?
4949
* How many open issues are there?
5050
* How many open PRs are there?
5151
* What is the throughput of the given SDK where the issue is?
5252
* What is the overall usage footprint?
53-
* What’s the difficulty of the change set/fix?
53+
* What’s the difficulty of the changeset/fix?
5454
* How much friction is the issue causing?
5555
* What's the overall time/effort cost of addressing the issue/need?
5656
etc...

profile/README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
![image](https://user-images.githubusercontent.com/139819/199528006-bc534966-4aee-45da-8d1e-0e71b97a56b3.png)
22

33

4-
👋 Hey Octokit friends!
4+
👋 Hey Octokit friends!
55

6-
We're glad you're here! This is where we host all of our Official[^1] SDKs for the GitHub API.
6+
We're glad you're here! This is where we host all of our Official[^1] SDKs for the GitHub API.
77

88
Currently, GitHub maintains SDKs for the following languages/frameworks/platforms:
99
- [JavaScript](https://github.com/octokit?language=javascript#org-profile-repositories) / [TypeScript](https://github.com/octokit?language=typescript#org-profile-repositories)
@@ -16,16 +16,17 @@ If you're already a contributor we can't thank you enough for being part of maki
1616

1717
## Code of conduct
1818

19-
Open source projects can be amazing things and while the source code they provide is an important component of the project
20-
it's definitely not the only thing that makes it amazing... you are!
19+
Open source projects can be amazing things and while the source code they provide is an important component of the project
20+
it's definitely not the only thing that makes it amazing... you are!
2121

2222
Practice kindnes, be welcoming, and always assume that we all have something to learn. Take a minute to read more about our [code of conduct](CODE_OF_CONDUCT.md).
2323

2424
## Contributing
2525

26-
While each community in our collection of Octokit communities is unique and have some really great nuances we have standard approaches across all of our repos
27-
to lower barriors to entry and reduce the friction of getting things done. Make sure to have a look at each of the repositorie's `CONTRIBUTING` docs above when
28-
making contributions. Oh, and thanks for being amazing and helping to both improve our communities and code! ❤️
26+
While each community in our collection of Octokit communities is unique and has its own individuality, we have standard approaches across all of our repos
27+
to lower barriors to entry and reduce the friction of getting things done. Make sure to have a look at each repository's `CONTRIBUTING` docs above when
28+
making contributions. For more information on how our team prioritizes and responds to issues, PRs, and discussions, please see [this document](../community/prioritization_response.md).
29+
Oh, and thanks for being amazing and helping to both improve our communities and code! ❤️
2930

30-
[^1]:Official just means GitHub and folks from GitHub support and maintain these libraries on an ongoing basis.
31+
[^1]:Official just means GitHub and folks from GitHub support and maintain these libraries on an ongoing basis.
3132
You can checkout some of the other amazing SDKs created and maintained by the community [here](https://docs.github.com/en/rest/overview/libraries)!

0 commit comments

Comments
 (0)