Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Mauro Stettler <[email protected]>
  • Loading branch information
jotdl and replay authored Apr 26, 2024
1 parent cbf9a38 commit 81d5068
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Matcher configuration:

| Parameter | Type | Required | Default | Description |
| ---------- | --------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `matchers` | List of Matcher | false | `[]` | List matchers which are required to assign this label. Each matching matchers increases the likeliness (by weight) the owning label is assigned. At least one matcher needs to match to assign a label. |
| `matchers` | List of Matcher | false | `[]` | List matchers which are required to assign this label. Each matching matcher increases the likeliness (by weight) the owning label is assigned. At least one matcher needs to match to assign a label. |

Matcher:

Expand Down Expand Up @@ -123,7 +123,7 @@ ignoreLabels:

| Parameter | Type | Required | Default | Description |
| -------------- | -------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ignoreLabels` | List of Strings | false | `[]` | List of labels which mark this issue to be ignored. If triggered on an issue which has **one** of the labels to be ignored, the action exits without doing something |
| `ignoreLabels` | List of Strings | false | `[]` | List of labels which mark this issue to be ignored. If triggered on an issue which has at least **one** of the labels to be ignored, the action exits without doing something |
| `teams` | Map of Team configurations | true | `nil` | Definition of the teams this issue is distributed between. |

#### Team configuration struct
Expand Down Expand Up @@ -151,7 +151,7 @@ During the initial implementation it was carefully discussed if the action shoul

#### Fairness

Fairness in assigning issues to individuals of a team is subjective. As mean time to resolve depends on time of creation, issue complexity, productivity, knowledge, experience, availability and some degree of luck per team member it needs to be acknowledged that their is no objectional fair distribution of issues among a group of people. Taking all these metrics into account is almost impossible and most likely would require additional state which we would need to store somewhere. We also discussed ideas like the tracking the amount of completed issues per IC, but had to realise that issues which were hard to resolve (and therefore take a long time) would suffer from this. We will revisit the current approach after gaining experience with it, but start lightweight now.
Fairness in assigning issues to individuals of a team is subjective. As mean time to resolve depends on time of creation, issue complexity, productivity, knowledge, experience, availability and some degree of luck per team member it needs to be acknowledged that their is no objective fair distribution of issues among a group of people. Taking all these metrics into account is almost impossible and most likely would require additional state which we would need to store somewhere. We also discussed ideas like tracking the amount of completed issues per IC, but had to realise that issues which were hard to resolve (and therefore take a long time) would suffer from this. We will revisit the current approach after gaining experience with it, but start lightweight now.

### Google calendar configuration

Expand Down
2 changes: 1 addition & 1 deletion ic-assignment/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ inputs:
required: true
default: .auto-ic-assignment-cfg.yml
dry-run:
description: "With this option set only logs, but doesn't assign the issue in the end."
description: "With this option the decision only gets logged, but not change is made to the issue."
required: false
default: "true"
gcal-service-acount-key:
Expand Down

0 comments on commit 81d5068

Please sign in to comment.