From e3ed6ad57f6a7f4e968b5027c648f81f9ab61c84 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Wed, 6 Apr 2022 12:51:55 +0200 Subject: [PATCH 1/5] Update reputation document to use `x:rep` label --- using/product/reputation.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/using/product/reputation.md b/using/product/reputation.md index 9003c1ae..5ba642f6 100644 --- a/using/product/reputation.md +++ b/using/product/reputation.md @@ -65,13 +65,13 @@ 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:size/tiny` | 3 | | -| `x:size/small` | 5 | | -| `x:size/medium` | 12 | | -| `x:size/large` | 30 | | -| `x:size/massive` | 100 | | +| Label | Reputation | Examples | +| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `x:rep/tiny` | 3 | | +| `x:rep/small` | 5 | | +| `x:rep/medium` | 12 | | +| `x:rep/large` | 30 | | +| `x:rep/massive` | 100 | | The examples above can serve as rough orientation when to apply which label but maintainers are free to use their own judgement. @@ -79,7 +79,7 @@ The examples above can serve as rough orientation when to apply which label but - If a pull request is still open, no reputation is awarded (yet). - If a pull request is closed _without_ merging, no reputation is awarded. -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. +Note that an `x:rep` label on an **issue** never affects the awarded reputation - even if a merged pull request lacks an `x:rep` label, and closes an issue that has one. ### Reviewing a pull requests @@ -91,13 +91,13 @@ For each merged or closed pull request reviewed by the user, `5` reputation is a - The reputation awarded for a pull request review changes if one of the following labels are added to the pull request: - | Label | Reputation | - | ---------------- | ---------- | - | `x:size/tiny` | 1 | - | `x:size/small` | 2 | - | `x:size/medium` | 5 | - | `x:size/large` | 10 | - | `x:size/massive` | 20 | + | Label | Reputation | + | --------------- | ---------- | + | `x:rep/tiny` | 1 | + | `x:rep/small` | 2 | + | `x:rep/medium` | 5 | + | `x:rep/large` | 10 | + | `x:rep/massive` | 20 | If more than one label is specified, the label with the highest reputation value determines the awarded reputation. From 046842e78e1e9a0707bf1516bc22bfb7603b07bb Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Wed, 6 Apr 2022 12:58:47 +0200 Subject: [PATCH 2/5] Document rep for opening issue --- using/product/reputation.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/using/product/reputation.md b/using/product/reputation.md index 5ba642f6..4ebc7ba9 100644 --- a/using/product/reputation.md +++ b/using/product/reputation.md @@ -109,3 +109,22 @@ For each pull request that was merged by the user, `1` reputation is awarded. - If a pull request is closed _without_ merging, no reputation is awarded. - The user that opened the pull request does _not_ get reputation for merging their own pull request. - If the pull request does not have any reviews, `5` reputation is awarded instead. + +### Opening an issue + +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 | | +| `x:rep/small` | 5 | | +| `x:rep/medium` | 12 | | +| `x:rep/large` | 30 | | +| `x:rep/massive` | 100 | | + +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. + +- If more than one label is specified, the label with the highest reputation value determines the awarded reputation. From 4cfd9e638d37e7367063af02aee66c0b93dfed78 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Fri, 22 Apr 2022 11:06:28 +0200 Subject: [PATCH 3/5] Add backwards compatibility note --- using/product/reputation.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/using/product/reputation.md b/using/product/reputation.md index 4ebc7ba9..46cbfc63 100644 --- a/using/product/reputation.md +++ b/using/product/reputation.md @@ -81,6 +81,8 @@ The examples above can serve as rough orientation when to apply which label but Note that an `x:rep` label on an **issue** never affects the awarded reputation - even if a merged pull request lacks an `x:rep` label, and closes an issue that has one. +_For backwards compatibility purposes, we also support using the `x:size` labels to determine the awarded reputation._ + ### Reviewing a pull requests For each merged or closed pull request reviewed by the user, `5` reputation is awarded. @@ -101,6 +103,8 @@ For each merged or closed pull request reviewed by the user, `5` reputation is a 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._ + ### Merging a pull request For each pull request that was merged by the user, `1` reputation is awarded. From e337ba05f01184e1879dc172bb8a6d6f758fb062 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Fri, 22 Apr 2022 14:37:12 +0200 Subject: [PATCH 4/5] Update rep doc --- using/product/reputation.md | 39 ++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/using/product/reputation.md b/using/product/reputation.md index 46cbfc63..abf32b27 100644 --- a/using/product/reputation.md +++ b/using/product/reputation.md @@ -65,22 +65,21 @@ 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 |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| -| `x:rep/small` | 5 |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| -| `x:rep/medium` | 12 |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| -| `x:rep/large` | 30 |
  • Adding a new concept or practice exercise
  • Adding new concept documentation
  • Substantial re-writing of an existing concept or exercise
  • Adding new CI scripts or other automation
| -| `x:rep/massive` | 100 |
  • Creating a test-runner, analyzer, representer or generator from scratch
  • Major refactors to those tools
  • Creating major documentation from scratch (e.g. contribution or testing guides)
| +| Label | Reputation | Examples | +| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `x:rep/tiny` | 3 (~5 mins) |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| +| `x:rep/small` | 5 (~10 mins) |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| +| `x:rep/medium` | 12 (~30 mins) |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| +| `x:rep/large` | 30 (~2 hrs) |
  • Adding a new concept or practice exercise
  • Adding new concept documentation
  • Substantial re-writing of an existing concept or exercise
  • Adding new CI scripts or other automation
| +| `x:rep/massive` | 100 (~5 hrs) |
  • Creating a test-runner, analyzer, representer or generator from scratch
  • Major refactors to those tools
  • Creating major documentation from scratch (e.g. contribution or testing guides)
| 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. -Note that an `x:rep` label on an **issue** never affects the awarded reputation - even if a merged pull request lacks an `x:rep` label, and closes an issue that has one. - _For backwards compatibility purposes, we also support using the `x:size` labels to determine the awarded reputation._ ### Reviewing a pull requests @@ -101,6 +100,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._ @@ -120,15 +122,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 |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| -| `x:rep/small` | 5 |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| -| `x:rep/medium` | 12 |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| -| `x:rep/large` | 30 |
  • Fully-fleshed out Concept Exercise
| -| `x:rep/massive` | 100 |
  • Designing a track curriculum
| +| Label | Reputation | Examples | +| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `x:rep/tiny` | 3 (~5 mins) |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| +| `x:rep/small` | 5 (~10 mins) |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| +| `x:rep/medium` | 12 (~30 mins) |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| +| `x:rep/large` | 30 (~2 hrs) |
  • Fully-fleshed out Concept Exercise
| +| `x:rep/massive` | 100 (~5 hrs) |
  • Designing a track curriculum
| -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. From cfbacb18c3472b257563d3856b279ee384bf6e42 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Thu, 14 Jul 2022 13:02:35 +0200 Subject: [PATCH 5/5] Remove time estimates --- using/product/reputation.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/using/product/reputation.md b/using/product/reputation.md index abf32b27..1e939389 100644 --- a/using/product/reputation.md +++ b/using/product/reputation.md @@ -65,13 +65,13 @@ 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 (~5 mins) |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| -| `x:rep/small` | 5 (~10 mins) |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| -| `x:rep/medium` | 12 (~30 mins) |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| -| `x:rep/large` | 30 (~2 hrs) |
  • Adding a new concept or practice exercise
  • Adding new concept documentation
  • Substantial re-writing of an existing concept or exercise
  • Adding new CI scripts or other automation
| -| `x:rep/massive` | 100 (~5 hrs) |
  • Creating a test-runner, analyzer, representer or generator from scratch
  • Major refactors to those tools
  • Creating major documentation from scratch (e.g. contribution or testing guides)
| +| Label | Reputation | Examples | +| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `x:rep/tiny` | 3 |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| +| `x:rep/small` | 5 |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| +| `x:rep/medium` | 12 |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| +| `x:rep/large` | 30 |
  • Adding a new concept or practice exercise
  • Adding new concept documentation
  • Substantial re-writing of an existing concept or exercise
  • Adding new CI scripts or other automation
| +| `x:rep/massive` | 100 |
  • Creating a test-runner, analyzer, representer or generator from scratch
  • Major refactors to those tools
  • Creating major documentation from scratch (e.g. contribution or testing guides)
| The examples above can serve as rough orientation when to apply which label but maintainers are free to use their own judgement. @@ -118,17 +118,15 @@ For each pull request that was merged by the user, `1` reputation is awarded. ### Opening an issue -By default, **no reputation is awarded** when an issue is opened. +Like pull requests, by default, **no reputation is awarded** when an issue is opened. +Unlike pull requests, reputation is only awarded for large or massive issues. 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 (~5 mins) |
  • Fixing a single typo or link
  • Removing a blank line or adding a line break
  • Changing/adding a single code comment
| -| `x:rep/small` | 5 (~10 mins) |
  • Fixing a single test case, task or example
  • Fixing multiple typos or links in a single file
  • Clarifying content by adding a few lines to a file
| -| `x:rep/medium` | 12 (~30 mins) |
  • Syncing an exercise with problem-specifications (incl. edits)
  • Adding one or more test cases from scratch
  • Improving multiple files in an exercise
  • Adding mentor notes for an exercise from scratch
  • Fixing a small bug in a test runner/analyzer/representer
  • Adding analyzer comments for a single exericse
| -| `x:rep/large` | 30 (~2 hrs) |
  • Fully-fleshed out Concept Exercise
| -| `x:rep/massive` | 100 (~5 hrs) |
  • Designing a track curriculum
| +| Label | Reputation | Examples | +| --------------- | ---------- | ---------------------------------------------------- | +| `x:rep/large` | 30 |
  • Fully-fleshed out Concept Exercise
| +| `x:rep/massive` | 100 |
  • Designing a track curriculum
| The examples above can serve as rough orientation when to apply which label, but maintainers are free to use their own judgement.