[bisq-network/compensation] Modify issue template to accommodate new tabular format (#585)

Chris Beams notifications at github.com
Tue Jun 16 07:09:47 UTC 2020


@cbeams requested changes on this pull request.

NACK, just a a few nits to resolve, see review comments.

Note that I've updated the parsed:* labels to link to their associated documentation in the wiki, as we do with other process-oriented labels.

Also, can someone refer me to a test issue where linting/parsing failed? I haven't seen this for myself yet.

>  
 
 ## 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._

"See comments below the table for guidance" shows up in the rendered issue, but the comments being referred to do not because they are HTML comments. This leads to a situation like we see in bisq-network/compensation#583, where @jmacxx left the "See comments below" text in place, but then there are no comments to be seen. This is confusing for the uninitiated reader. I immediately scrolled down looking for the comments and was frustrated not to find them. I'm sure others will have the same experience.

Quick solution would be to just put the "See comments..." text in an HTML comment so that the submitter sees it only when creating / editing the issue.

>  
-## Roles performed
+Example 2 - role (note the asterisk):

What is the significance of the asterisk?

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

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

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/compensation/pull/585#pullrequestreview-431213749
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20200616/3d4c25ab/attachment.html>


More information about the bisq-github mailing list