Skip to content

Commit 4c55a75

Browse files
committed
chore(contrib): link to prioritization method
1 parent dca7a7c commit 4c55a75

File tree

1 file changed

+1
-32
lines changed

1 file changed

+1
-32
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -28,38 +28,7 @@ The roadmap is just a ranking of the currently open issues and no hard dates are
2828

2929
I have added version release milestones to some of the issues to give a sense of what is coming in what order. View milestones [here](https://github.com/mharrisb1/openai-responses-python/milestones).
3030

31-
I (Michael) am the BDFL of the project and can and will arbitrarily rank issues according to my own needs (and those of my [employer](https://www.definite.app)) but for the most part I try to evaluate priority of issues based on a 2-dimensional system that looks at **_effort_** and **_impact_**.
32-
33-
- _Effort_ is a rough estimate of whether something will take a lot of work, some work, or little work to implement
34-
- _Impact_ is a rough estimate of how important something is
35-
36-
Both are unscientific and flawed but they allow me to try to focus on what to work on when.
37-
38-
If you look at the [project's issues](https://github.com/mharrisb1/openai-responses-python/issues), you'll see they are labeled with some non-standard issue labels.
39-
40-
| Label | Description |
41-
| ------------------------------------------------------------------------------------ | ------------- |
42-
| <span style='background-color: green; padding: 2px; border-radius: 5px'>e0 🌵</span> | Low effort |
43-
| <span style='background-color: yellow; padding: 2px; border-radius: 5px'>e1 ⚡️</span> | Medium effort |
44-
| <span style='background-color: red; padding: 2px; border-radius: 5px'>e2 🔥</span> | High effort |
45-
| <span style='background-color: green; padding: 2px; border-radius: 5px'>i0 🌵</span> | Low impact |
46-
| <span style='background-color: yellow; padding: 2px; border-radius: 5px'>i1 ⚡️</span> | Medium impact |
47-
| <span style='background-color: red; padding: 2px; border-radius: 5px'>i2 🔥</span> | High impact |
48-
49-
Ranking is evaluated according to this quadrant where the priority is ordered from top to bottom and left to right.
50-
51-
```mermaid
52-
quadrantChart
53-
title Issue Ranking
54-
x-axis Low Effort --> High Effort
55-
y-axis Low Impact --> High Impact
56-
quadrant-1 Medium Priority
57-
quadrant-2 Highest Priority
58-
quadrant-3 Low Priority
59-
quadrant-4 Lowest Priority
60-
```
61-
62-
View ranked [open issues](https://github.com/users/mharrisb1/projects/4) and [in progress](https://github.com/users/mharrisb1/projects/4/views/2) issues.
31+
I (Michael) am the BDFL of the project and can and will arbitrarily rank issues according to my own needs (and those of my [employer](https://www.definite.app)) but for the most part I try to evaluate priority of issues based on an [Impact-Effort Analysis](https://github.com/mharrisb1/iea).
6332

6433
## Setting up development environment
6534

0 commit comments

Comments
 (0)