Skip to content

Commit f0d062b

Browse files
Document reputation label (#347)
* Update reputation document to use `x:rep` label * Document rep for opening issue * Add backwards compatibility note * Update rep doc * Remove time estimates
1 parent 2977ce2 commit f0d062b

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

using/product/reputation.md

+39-15
Original file line numberDiff line numberDiff line change
@@ -65,21 +65,22 @@ By default, `12` reputation is awarded when a pull request is merged that was op
6565

6666
Depending on the content of the pull request, a maintainer can award more (or less) reputation by adding one of the following labels to the pull request:
6767

68-
| Label | Reputation | Examples |
69-
| ---------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
70-
| `x:size/tiny` | 3 | <ul><li>Fixing a single typo or link</li><li>Removing a blank line or adding a line break</li><li>Changing/adding a single code comment</li></ul> |
71-
| `x:size/small` | 5 | <ul><li>Fixing a single test case, task or example</li><li>Fixing multiple typos or links in a single file</li><li>Clarifying content by adding a few lines to a file</li></ul> |
72-
| `x:size/medium` | 12 | <ul><li>Syncing an exercise with problem-specifications (incl. edits)</li><li>Adding one or more test cases from scratch</li><li>Improving multiple files in an exercise</li><li>Adding mentor notes for an exercise from scratch</li><li>Fixing a small bug in a test runner/analyzer/representer</li><li>Adding analyzer comments for a single exericse</li></ul> |
73-
| `x:size/large` | 30 | <ul><li>Adding a new concept or practice exercise</li><li>Adding new concept documentation</li><li>Substantial re-writing of an existing concept or exercise</li><li>Adding new CI scripts or other automation</li></ul> |
74-
| `x:size/massive` | 100 | <ul><li>Creating a test-runner, analyzer, representer or generator from scratch</li><li>Major refactors to those tools</li><li>Creating major documentation from scratch (e.g. contribution or testing guides)</li></ul> |
68+
| Label | Reputation | Examples |
69+
| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
70+
| `x:rep/tiny` | 3 | <ul><li>Fixing a single typo or link</li><li>Removing a blank line or adding a line break</li><li>Changing/adding a single code comment</li></ul> |
71+
| `x:rep/small` | 5 | <ul><li>Fixing a single test case, task or example</li><li>Fixing multiple typos or links in a single file</li><li>Clarifying content by adding a few lines to a file</li></ul> |
72+
| `x:rep/medium` | 12 | <ul><li>Syncing an exercise with problem-specifications (incl. edits)</li><li>Adding one or more test cases from scratch</li><li>Improving multiple files in an exercise</li><li>Adding mentor notes for an exercise from scratch</li><li>Fixing a small bug in a test runner/analyzer/representer</li><li>Adding analyzer comments for a single exericse</li></ul> |
73+
| `x:rep/large` | 30 | <ul><li>Adding a new concept or practice exercise</li><li>Adding new concept documentation</li><li>Substantial re-writing of an existing concept or exercise</li><li>Adding new CI scripts or other automation</li></ul> |
74+
| `x:rep/massive` | 100 | <ul><li>Creating a test-runner, analyzer, representer or generator from scratch</li><li>Major refactors to those tools</li><li>Creating major documentation from scratch (e.g. contribution or testing guides)</li></ul> |
7575

7676
The examples above can serve as rough orientation when to apply which label but maintainers are free to use their own judgement.
7777

78+
- The estimated number of time spent should be interpreted as the average time a _maintainer_ would spend on doing the PR.
7879
- If more than one label is specified, the label with the highest reputation value determines the awarded reputation.
7980
- If a pull request is still open, no reputation is awarded (yet).
8081
- If a pull request is closed _without_ merging, no reputation is awarded.
8182

82-
Note that an `x:size` label on an **issue** never affects the awarded reputation - even if a merged pull request lacks an `x:size` label, and closes an issue that has one.
83+
_For backwards compatibility purposes, we also support using the `x:size` labels to determine the awarded reputation._
8384

8485
### Reviewing a pull requests
8586

@@ -91,16 +92,21 @@ For each merged or closed pull request reviewed by the user, `5` reputation is a
9192

9293
- The reputation awarded for a pull request review changes if one of the following labels are added to the pull request:
9394

94-
| Label | Reputation |
95-
| ---------------- | ---------- |
96-
| `x:size/tiny` | 1 |
97-
| `x:size/small` | 2 |
98-
| `x:size/medium` | 5 |
99-
| `x:size/large` | 10 |
100-
| `x:size/massive` | 20 |
95+
| Label | Reputation |
96+
| --------------- | ---------- |
97+
| `x:rep/tiny` | 1 |
98+
| `x:rep/small` | 2 |
99+
| `x:rep/medium` | 5 |
100+
| `x:rep/large` | 10 |
101+
| `x:rep/massive` | 20 |
102+
103+
It is _not_ possible to use different reputation "sizes" for a pull request author and reviewer.
104+
Both are based on the same `x:rep` label.
101105

102106
If more than one label is specified, the label with the highest reputation value determines the awarded reputation.
103107

108+
_For backwards compatibility purposes, we also support using the `x:size` labels to determine the awarded reputation._
109+
104110
### Merging a pull request
105111

106112
For each pull request that was merged by the user, `1` reputation is awarded.
@@ -109,3 +115,21 @@ For each pull request that was merged by the user, `1` reputation is awarded.
109115
- If a pull request is closed _without_ merging, no reputation is awarded.
110116
- The user that opened the pull request does _not_ get reputation for merging their own pull request.
111117
- If the pull request does not have any reviews, `5` reputation is awarded instead.
118+
119+
### Opening an issue
120+
121+
Like pull requests, by default, **no reputation is awarded** when an issue is opened.
122+
Unlike pull requests, reputation is only awarded for large or massive issues.
123+
124+
Depending on the content of the issue, a maintainer can choose to award reputation by adding one of the following labels to the issue:
125+
126+
| Label | Reputation | Examples |
127+
| --------------- | ---------- | ---------------------------------------------------- |
128+
| `x:rep/large` | 30 | <ul><li>Fully-fleshed out Concept Exercise</li></ul> |
129+
| `x:rep/massive` | 100 | <ul><li>Designing a track curriculum</li></ul> |
130+
131+
The examples above can serve as rough orientation when to apply which label, but maintainers are free to use their own judgement.
132+
133+
- The reputation should reflect the amount of effort that _maintainer_ would spend to create the issue.
134+
135+
- If more than one label is specified, the label with the highest reputation value determines the awarded reputation.

0 commit comments

Comments
 (0)