Skip to content

Commit

Permalink
Update rep doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ErikSchierboom
ErikSchierboom committed Apr 22, 2022
1 parent 4cfd9e6 commit 1f17c61
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions using/product/reputation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,17 @@ By default, `12` reputation is awarded when a pull request is merged that was op

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:

| Label | Reputation | Examples |
| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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> |
| `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> |
| `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> |
| `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> |
| `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> |
| Label | Reputation | Examples |
| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x:rep/tiny` | 3 (~5 mins) | <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> |
| `x:rep/small` | 5 (~10 mins) | <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> |
| `x:rep/medium` | 12 (~30 mins) | <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> |
| `x:rep/large` | 30 (~2 hrs) | <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> |
| `x:rep/massive` | 100 (~5 hrs) | <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> |

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

- The estimated number of time spent should be interpreted as the average time a _maintainer_ would spend on doing the PR.
- If more than one label is specified, the label with the highest reputation value determines the awarded reputation.
- If a pull request is still open, no reputation is awarded (yet).
- If a pull request is closed _without_ merging, no reputation is awarded.
Expand All @@ -101,6 +102,9 @@ For each merged or closed pull request reviewed by the user, `5` reputation is a
| `x:rep/large` | 10 |
| `x:rep/massive` | 20 |

It is _not_ possible to use different reputation "sizes" for a pull request author and reviewer.
Both are based on the same `x:rep` label.

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

_For backwards compatibility purposes, we also support using the `x:size` labels to determine the awarded reputation._
Expand All @@ -120,15 +124,16 @@ By default, **no reputation is awarded** when an issue is opened.

Depending on the content of the issue, a maintainer can choose to award reputation by adding one of the following labels to the issue:

| Label | Reputation | Examples |
| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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> |
| `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> |
| `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> |
| `x:rep/large` | 30 | <ul><li>Fully-fleshed out Concept Exercise</li></ul> |
| `x:rep/massive` | 100 | <ul><li>Designing a track curriculum</li></ul> |
| Label | Reputation | Examples |
| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x:rep/tiny` | 3 (~5 mins) | <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> |
| `x:rep/small` | 5 (~10 mins) | <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> |
| `x:rep/medium` | 12 (~30 mins) | <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> |
| `x:rep/large` | 30 (~2 hrs) | <ul><li>Fully-fleshed out Concept Exercise</li></ul> |
| `x:rep/massive` | 100 (~5 hrs) | <ul><li>Designing a track curriculum</li></ul> |

The reputation should reflect the amount of effort that went into creating the issue.
The examples above can serve as rough orientation when to apply which label but maintainers are free to use their own judgement.
The examples above can serve as rough orientation when to apply which label, but maintainers are free to use their own judgement.

- The reputation should reflect the amount of effort that _maintainer_ would spend to create the issue.

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

0 comments on commit 1f17c61

Please sign in to comment.