-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Modify issue template to accommodate new tabular format #585
Changes from all commits
a6a4fbd
005d183
508e0cc
f762323
1b94f34
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,60 @@ | ||
<!-- | ||
Compensation requests have a specific format that enables them to be evaluated by a bot for more efficient budgeting. Please make sure you stick to the template. A linter will evaluate your request after you remove [WIP] from the issue title and notify you of any issues. | ||
|
||
See the following link for details: | ||
https://bisq.wiki/Making_a_compensation_request | ||
|
||
Feel free to browse other requests if you're not sure about something, or reach out in #compensation on Keybase (https://keybase.io/team/bisq). | ||
--> | ||
|
||
|
||
## Summary | ||
|
||
> _Specify the total amount of BSQ you are requesting:_ | ||
> _Specify the total amount of BSQ you are requesting, along with the USD total and BSQ/USD rate:_ | ||
|
||
- BSQ requested: | ||
|
||
<!-- | ||
Don't forget to make your compensation request in the actual Bisq DAO! See the following link for details: | ||
https://docs.bisq.network/compensation.html | ||
--> | ||
- **BSQ requested**: **`[BSQ amount]`** <!-- [BSQ amount] should be: USD amount / BSQ rate --> | ||
- USD requested: [USD amount] <!-- [USD amount] should be: total of all contributions listed in "contributions delivered" table below --> | ||
- BSQ rate: [rate] USD per BSQ <!-- [rate] should be the rate used to determine the BSQ amount above, as specified in the cycle's rate announcement (https://bisq.wiki/Compensation_Maintainer#Announce_BSQ-USD_rate) --> | ||
- Previous compensation request (if applicable): # <!-- Link to last compensation request submitted --> | ||
|
||
|
||
## Contributions delivered | ||
|
||
> _Provide links to contributions you have [delivered](https://github.com/bisq-network/proposals/issues/19), the amount of BSQ you are requesting for each, and any comments that will help stakeholders understand its value._ | ||
> _Add contributions you have [delivered](https://github.com/bisq-network/proposals/issues/19) and roles you have performed here as new rows in the table below. Role line-items should include an asterisk (*) in the team column._ | ||
|
||
| Title | Team | USD | Link | Notes | | ||
| --- | --- | --- | --- | --- | | ||
|
||
## Contributions in progress | ||
<!-- | ||
|
||
Each contribution should be a new line-item in the table above. | ||
|
||
Title - optional, string. | ||
Team - optional, must one of the following: admin, dev, growth, ops, support (case-insensitive). If the line-item is for a role, please add a `*`. See Example 2 below. | ||
USD - optional, number. Please do not specify 'USD', as the column title makes units clear. | ||
Link - optional, string. | ||
Notes - optional, string. | ||
|
||
> _Provide links to work you're involved with that is still [in progress](https://github.com/bisq-network/proposals/issues/19). **This section is optional,** and is for your own benefit in keeping track of what you're doing and keeping other contributors up to date with the same._ | ||
Example 1 - typical contribution: | ||
|
||
| Add local Bitcoin node configuration detection | dev | 240 | https://github.com/bisq-network/bisq/pull/3982 | ||
|
||
## Roles performed | ||
Example 2 - role (note the asterisk): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is the significance of the asterisk? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No significance to the bot, it ignores any asterisk after the team name. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah the bot currently ignores it, but its purpose is to mark line-items for roles (so that they can be distinguished from regular work-delivered line-items). I figure this will be useful when we start aggregating qualitative assessments of issuance. Role contributions can be thought of as the project's 'overhead', and tracking the proportion of overhead in relation to overall issuance could be useful. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok, I think that without further change, people won't get that they should mark role entries with an asterisk. It's just too subtle / not explicit enough here. But I wouldn't personally hold up the merge on it at this point. If it's something that people should do, I'd recommend saying that clearly. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed with 1b94f34. Will probably still need to remind people, lead by example, etc., but role owners are mostly core/active contributors so it should be ok. |
||
|
||
| Community manager | growth* | 400 | https://github.com/bisq-network/roles/issues/95#issuecomment-628431613 | ||
|
||
Example 3 - list of minor contributions, such as reviews: | ||
|
||
| | | | https://github.com/bisq-network/bisq/pull/3968 | This and PRs below too small to be valued separately. See total at bottom. | ||
| | | | https://github.com/bisq-network/bisq/pull/4040 | ||
| | | | https://github.com/bisq-network/bisq/pull/4044 | ||
| | | | https://github.com/bisq-network/bisq/pull/4048 | ||
| | | | https://github.com/bisq-network/bisq/pull/4066 | ||
| | dev | 400 | https://github.com/bisq-network/bisq/pull/4062 | Total for items above. | ||
|
||
--> | ||
|
||
|
||
## Contributions in progress | ||
|
||
> _Provide links to your [monthly report](https://github.com/bisq-network/proposals/issues/13) on any roles you are responsible for._ | ||
> _Provide links to work you're involved with that is still [in progress](https://github.com/bisq-network/proposals/issues/19). **This section is optional (the linter ignores it),** and is for your own benefit in keeping track of what you're doing and keeping other contributors up to date with the same._ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jmacxx would such a change require any modifications to bot code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see any impact to the bot by that change. Presumably the user would link back to their previous compensation request.