[FEATURE] Lay groundwork for BOUNTIES 💸

jobenjada commented 5 months ago

Is your feature request related to a problem? Please describe.

Currently, it is not possible to add bounties to issues. So we ship it :)

Describe the solution you'd like

We have this great, in-depth concept written bei the oss.gg PM team 🤓 Please read it carefully so you know what you're up to:

https://www.notion.so/ossgg/Bounty-System-A-Unified-Concept-e1782477db714bd18904aefb2ebbccac?pvs=4

Some aspect of the Concept are too far reaching, so I'll boil it down a bit and add some context on how to implement it:

Dive deep into the Tremendous docs: https://developers.tremendous.com/docs/introduction We will use Tremendous to handle the bounty payouts. It's free for us and provides all the integrations that we need
In terms of bounty creation UX, we start with creating bounties only on Github (in the same way you can only award points via GitHub right now). Look at how we use /award to award points in PRs. Similarly maintainers can add bounties to issues with /bounty 50 where 50 is the USD amount.
Start with the schema. Add a new model Bounty to schema.prisma file with the following fields:

id: ccid (unique)
usdAmount: int
status: open/redeemed
issueUrl: 
createdAt:
updatedAt:
userId: String
repositoryId: String

user: User (relation)
repository: Repository (relation)

Very similar to the pointTransaction model, right?

Write a ZOD schema and derive a type from it (follow the same structure like the point Transaction)

This is the ground work. Now, we will make our lives easier!!

Instead of creating and updating the bounty in our db when the maintainer runs /bounty we keep everything on Github until a PR gets merged. This keeps the whole bounty thing analog to how we handle pointTransactions.

Write a GitHub action which is triggered if a maintainer runs /bounty 50 with the following checks:
- Is issue or PR? If PR, display "Bounties can only be setup in issues, not in PRs."
- Does already have bounty? "The bounty was updated to new value"
- Add a label (like the one you can see on this issue "💸 50 USD" in green. If it already has such a label, skip. If it has a different bounty label, remove the old and add the new one.
Now comes the interesting part: If a PR gets merged successfully and it has a valid bounty label attached to it a series of things happens:

We create the bounty in oss.gg database with all the info we have
We trigger Tremendous to issue such a bounty
We send the instructions to redeem it to the email of the contributor
We add a comment to the merged PR: "Thanks a lot for your valuable contribution mate! Pls check your inbox for all details to redeem your bounty of 50 USD!"

Once the bounty was redeemed:

If there is some kind of call back, we should update the bounty status to redeemed.

This should be the most basic implementation of it with all important parts setup 🤓 However...

Please think along! You'll be the expert and if you find a smarter/quicker/better way to build this, please let me know :)

For question, pls hit up @jobenjada

Thanks! 🤸

Describe alternatives you've considered

No response

Additional context

No response

raysubham commented 5 months ago

/assign