Skip to content
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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jun 17, 2020
Merged

Modify issue template to accommodate new tabular format #585

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a6a4fbd
Modify issue template to accommodate new format
Jun 16, 2020
005d183
Remove misleading note about "see comments below"
Jun 16, 2020
508e0cc
Change mentions of "parser" to "linter"
Jun 16, 2020
f762323
Add field for last compensation request
Jun 17, 2020
1b94f34
Add note about asterisk in team column for roles
Jun 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 46 additions & 12 deletions ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,59 @@
<!--
Compensation requests have a specific format that enables them to be parsed programmatically 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'linter' is used here, 'parser' is used below. Might be best to use a single term, since it is a single bot doing the work.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True but there are 2 processes -- linting before voting and then parsing after voting, which is why 2 terms were used. But I agree a consistent term would probably be clearer for users so I've changed it.


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) -->

Copy link
Contributor

@MwithM MwithM Jun 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Previous compensation request: # <!-- Link to last compensation request submitted -->

Copy link
Author

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?

Copy link

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.


## 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) here as new rows in the table below. See comments below the table for guidance._
m52go marked this conversation as resolved.
Show resolved Hide resolved

| 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):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the significance of the asterisk?

Copy link

Choose a reason for hiding this comment

The 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.

Copy link
Author

@m52go m52go Jun 16, 2020 •
edited
Loading

Choose a reason for hiding this comment

The 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.

Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Author

Choose a reason for hiding this comment

The 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 parser 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._