Difference between revisions of "Compensation Maintainer"

From Bisq Wiki
Jump to navigation Jump to search
(place compensation maintainer role duties in role article (copied from compensation article -- in both places, for now))
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This article documents the ''Compensation Maintainer'' [[role]].
+
The '''Compensation Maintainer''' handles announcements and issue triaging for compensation requests.
  
 
__TOC__
 
__TOC__
  
 
== Issue ==
 
== Issue ==
* [https://github.com/bisq-network/roles/issues/102 Support Team Lead #102]
+
https://github.com/bisq-network/roles/issues/86
  
 
== Team ==
 
== Team ==
===github===
+
[https://github.com/orgs/bisq-network/teams/compensation-maintainers @bisq-network/compensation-maintainers]
* [https://github.com/orgs/bisq-network/teams/compensation-maintainers Compensation Maintainer]
 
===wiki===
 
* [[Compensation_Maintainer|Compensation Maintainer]]
 
  
 
== Duties ==
 
== Duties ==
  
=== Announce BSQ-USD rate ===
+
=== Announce BSQ-USD exchange rate ===
  
Compensation requests [https://github.com/bisq-network/compensation/issues/519 should use a 90-day volume weighted average] to calculate a value for BSQ and mitigate its volatility. At the end of a Bisq DAO Cycle and beginning of a new one, the Compensation Maintainer should create a pinned issue with the title: <code>BSQ rate for Cycle X is Y.YY USD per 1 BSQ</code> and a screenshot of DAO Dashboard to announce the rates for the ongoing cycle.
+
Compensation requests use a [https://github.com/bisq-network/proposals/issues/313 30-day volume-weighted average] to determine a BSQ/USD rate that discounts outliers.  
 +
At the beginning of the cycle, the Compensation Maintainer should create a pinned issue with the title "BSQ rate for Cycle X is Y.YY USD per 1 BSQ".
 +
<!-- https://github.com/bisq-network/compensation/issues/782 -->
  
 
=== Announce request submission deadline ===
 
=== Announce request submission deadline ===
  
To give time for team leads to discuss and review Compensation Requests, requests need to be <code>Ready for review</code> one week prior to the end of current cycle's proposal phase. [[File:Compensation_board.png|400px|right|thumb|Compensation board]]The date and reminders will be announced at [https://github.com/orgs/bisq-network/teams/dao/discussions/ @bisq-network/dao], the [https://github.com/orgs/bisq-network/projects/5 Compensation board] and the [[Events Calendar]]
+
To allow time for team leads to discuss and review compensation requests, requests need to be ready for review 1 week before the end of current cycle's proposal phase.  
 +
 
 +
[[File:Compensation_board.png|400px|right|thumb|Compensation board]]
 +
 
 +
Dates and reminders will be announced on a pinned issue at github [https://github.com/bisq-network/compensation/issues compensation repository], the [https://github.com/orgs/bisq-network/projects/20/ compensation board], and the [[events calendar]].
  
 
=== Triage incoming requests ===
 
=== Triage incoming requests ===
Line 26: Line 29:
 
The Compensation Maintainer watches the [https://github.com/bisq-network/compensation/issues compensation repository] and proceeds to triage:
 
The Compensation Maintainer watches the [https://github.com/bisq-network/compensation/issues compensation repository] and proceeds to triage:
  
Incoming issues are classified as <code>Work in progress</code> if they have <code>[WIP]</code> at the beginning of the title or as <code>In Review</code> if they don't. Compensation Maintainer assigns 'In review' issues to corresponding team leads after looking at the content of the request. When in doubt, Compensation Maintainer should ask in the issue which team leaders are the appropriate for the issue.
+
Incoming issues are categorized as <code>In Progress</code> if they have <code>[WIP]</code> at the beginning of the title or as <code>In Review</code> if they don't. The Compensation Maintainer assigns <code>In Review</code> issues to the appropriate team leads (or determine which team leads are responsible if it isn't obvious).
  
The Compensation Maintainer should transition reviewed requests with DAO proposals transaction ID submitted to <code>Proposal Submitted</code> column.
+
As requests are submitted to the DAO (with txid posted in corresponding issues), the Compensation Maintainer should classify requests as <code>Proposal Submitted</code>.
  
Triage is controlled from the Compensation board, drag-and-dropping issues and using "add cards" to triage incoming issues, and directly from the issues, using the "projects" section in the right sidebar.
+
This triage can be controlled from the Compensation board by:
 +
* using the "Add cards" button on the board to triage new issues
 +
* dragging and dropping existing issues to categories
 +
* using the "Projects" section in the right sidebar of an issue's page
  
 
=== Archive previous cycle requests at the end of the proposal phase ===
 
=== Archive previous cycle requests at the end of the proposal phase ===
  
At the completion of the current cycle's proposal phase, the Compensation Maintainer should [https://help.github.com/en/github/managing-your-work-on-github/archiving-cards-on-a-project-board archive] all issues in the <code>Done</code> column from the previous phase.
+
Once a cycle's proposal phase is over, the Compensation Maintainer should [https://help.github.com/en/github/managing-your-work-on-github/archiving-cards-on-a-project-board archive] all issues in the <code>Done</code> column from the previous phase.
  
The reason for waiting to archive these issues is so that contributors can easily see how many requests were made in the last phase, to quickly find their own prior request, and to to easily review which ones were accepted and rejected. We archive them at the end of the proposal phase in order to keep the board clean and make room for requests in the current phase to populate the <code>Done</code> column.
+
The reason for waiting to archive these issues is so that contributors can easily see how many requests were made in the last cycle, quickly find their own request, and easily review which ones were accepted and rejected. Requests are archived in order to keep the board clean and make room for requests in the next cycle.
  
 
=== Close current cycle requests after the vote reveal phase ===
 
=== Close current cycle requests after the vote reveal phase ===
Line 43: Line 49:
  
 
# Label each compensation request issue as <code>was:accepted</code> or <code>was:rejected</code> according to the vote result
 
# Label each compensation request issue as <code>was:accepted</code> or <code>was:rejected</code> according to the vote result
# Close the issue with a comment that reads "Closing as accepted" or "Closing as rejected".
+
# Close the issue with a comment indicating the request's outcome (e.g., "Closing as accepted" or "Closing as rejected")
  
Once closed, the issues will automatically transition to the <code>Done</code> column of the board where they remain for reference until they are archived at the end of the next cycle's proposal phase (as per the section above).
+
Once closed, the issues will automatically move to the <code>Done</code> column of the board, where they remain for reference until they are archived at the end of the next cycle's proposal phase (see above).
  
 
== Rights ==
 
== Rights ==
<!-- list in bullet points all special privileges that owner(s) of this role are granted, e.g. repository access -->
+
* "Triage" access to the [https://github.com/bisq-network/compensation/ compensation repository]
* Repo Access: https://github.com/bisq-network/compensation/
 
  
 
== Bonding ==
 
== Bonding ==

Latest revision as of 16:27, 22 August 2024

The Compensation Maintainer handles announcements and issue triaging for compensation requests.

Issue

https://github.com/bisq-network/roles/issues/86

Team

@bisq-network/compensation-maintainers

Duties

Announce BSQ-USD exchange rate

Compensation requests use a 30-day volume-weighted average to determine a BSQ/USD rate that discounts outliers. At the beginning of the cycle, the Compensation Maintainer should create a pinned issue with the title "BSQ rate for Cycle X is Y.YY USD per 1 BSQ".

Announce request submission deadline

To allow time for team leads to discuss and review compensation requests, requests need to be ready for review 1 week before the end of current cycle's proposal phase.

Compensation board

Dates and reminders will be announced on a pinned issue at github compensation repository, the compensation board, and the events calendar.

Triage incoming requests

The Compensation Maintainer watches the compensation repository and proceeds to triage:

Incoming issues are categorized as In Progress if they have [WIP] at the beginning of the title or as In Review if they don't. The Compensation Maintainer assigns In Review issues to the appropriate team leads (or determine which team leads are responsible if it isn't obvious).

As requests are submitted to the DAO (with txid posted in corresponding issues), the Compensation Maintainer should classify requests as Proposal Submitted.

This triage can be controlled from the Compensation board by:

  • using the "Add cards" button on the board to triage new issues
  • dragging and dropping existing issues to categories
  • using the "Projects" section in the right sidebar of an issue's page

Archive previous cycle requests at the end of the proposal phase

Once a cycle's proposal phase is over, the Compensation Maintainer should archive all issues in the Done column from the previous phase.

The reason for waiting to archive these issues is so that contributors can easily see how many requests were made in the last cycle, quickly find their own request, and easily review which ones were accepted and rejected. Requests are archived in order to keep the board clean and make room for requests in the next cycle.

Close current cycle requests after the vote reveal phase

When the reveal vote phase is complete, the Compensation Maintainer should take the following steps:

  1. Label each compensation request issue as was:accepted or was:rejected according to the vote result
  2. Close the issue with a comment indicating the request's outcome (e.g., "Closing as accepted" or "Closing as rejected")

Once closed, the issues will automatically move to the Done column of the board, where they remain for reference until they are archived at the end of the next cycle's proposal phase (see above).

Rights

Bonding

N/A