Send notification comment with our Gitpaybot for users who needs to claim issue

alexanmtz commented 3 years ago

We need to make our bot help contributors who need to claim a bounty.

This user may have an account on Gitpay or not.

We will check this weekly in our cronjobs: https://github.com/worknenjoy/gitpay/blob/master/cron.js

This Cron will query all tasks with bounties with status closed not paid, and it will comment on the issue with the following message:

hello {{github_user}},

Here's is Gitpaybot with good news! You have a bounty to claim :-)

There's a bounty of $ {{amount}} for a task you solved on Gitpay.

If you have a Pull Request merged, please claim on Gitpay (https://gitpay.me) on the issue:
{{url}}

Please set the title of your pull request to *issue#{{issue_id}}* and go in _Solve issue_ and send your Pull Request URL.

Why

A user can solve an issue in which there's a bounty on Gitpay, and he needs to be notified somehow.

Level

Medium

Current behavior

Current issues with bounties on Gitpay not paid solved on Github by users, not on Gitpay will not know that they have paid to receive when they register on Gitpay.

Expected behavior

Our Github bot will comment on issues to help users to claim their bounties

Useful links

Github API: https://docs.github.com/en/rest
Our GithubBot comment module: https://github.com/worknenjoy/gitpay/blob/master/modules/bot/comment.js

How to reproduce the user scenario

Scenario 1
- Run the project locally
- Create a user
- Import an issue
- Pay for an issue (Create a coupon #828 with 100% discount )
- Send a pull request for that issue
- Merge issue
- Run the cron function
- You can test if the function of comment will be called (currently disabled if is not production)

What you will need to complete this issue

You should create a coupon to apply 100% discount to be able to do a payment successfully in your local environment.

Tips

All the UI will use Material UI (https://material-ui.com/)
Use our translation library Run npm run translate on the /frontend folder to sync translation before sending the PR.

leonardohofling commented 3 years ago

@alexanmtz Hey! About the first line of the message "hello {{github_user}},": if the user is not registered on gitpay and not assigned, I can't get this information.

I guess we will show the github_user only if the user is assigned and has a github account, right?

alexanmtz commented 3 years ago

@leonardohofling , yes, you will show only in that case 👍

worknenjoy / gitpay