Meeds-io / MIPs

The Meeds Improvement Proposal repository
0 stars 0 forks source link

Rewards Management Review #154

Open srenault-meeds opened 1 month ago

srenault-meeds commented 1 month ago

Rationale

Every week, hubs are using our rewarding feature to reward their contributors. After years of using it, it comes to the team to review the Rewards Management as it is currently implemented.

Indeed, we have multiple problems to solve, including:

In addition to it, this review will prepare the next steps for:

1. Functional Requirements

Top User Stories

Access to reward / UEM / wallet / perkstore

To guarantee we can use gamification without forcing the usage of wallet, rewards, perkstore, we reorganize functionally the admin menu:

That also means that we must be able to use gamification without installing the rewards addon. Indeed, only if rewards addon is in the package, then wallet, wom connection, perkstore are also listed and proposed in the platform

Set the budget

1. Access to Budget Setup

As admin or rewarding admin, I can access the budget setup from the same page to manage rewards Rewards & Blockchain > Rewards

2. Page when no budget yet configured

With placeholder and CTA to fund the wallet and to connect to WoM

image
3. Budget Setup Options

When requesting to setup the budget, a drawer opens to provide different configuration options:

Depending on the parameters, a distribution forecast is proposed below those options so the admin can see if that fits his requirements

image

Once the budget has been setup, then the configuration is reminded.

image

Then you can reward contributors as soon as you have contributions during the period

Rewards Management

1. Manage Rewards

As admin or rewarding one, I can access the rewards management from the same page you use to set the budget up.

Below the budget configuration, I have reward reports sorted chronologically from the current period to previous ones. These are listed as card and depending on the periodicity selected in the budget configuration.

Each card provides key infos as:

image
2. Access to a period details

Clicking to a card allows the admin to see the rewarded users list, sorted from the most rewarded to the less one, including no participants. From there, it is possible to:

image

When the rewards have not been sent yet, then the admin can click to reward Once done, a placeholder tells the admin it is in progress

image

If WoM connected, a placeholder tells him the report is being sent

image

Once ok, then the info about the reward status (AND if the case, the UEM report) is reminded

image

If this process has encountered difficulties, then the placeholder is updated so the admin can better know what needs to be done with a CTA when possible

Impacts

Gamification

Admin entry to manage gamification items

Notifications

NA

Analytics

NA

Unified Search

NA

2. Technical Requirements

Expected Volume & Performance

N/A

Security

N/A

Extensibility

N/A

Configurability

N/A

Upgradability

N/A

Existing Features

N/A

Feature Flags

N/A

Other Non Functional Requirements

N/A

4. Software Architecture

Security

N/A

Access

In this MIP we will make some UI and UX adjustments for admin rewards management and update admin navigations for gamification and rewarding. We will create a new portlet to set the reward budget (through a new drawer component) and list the reward reports with different details and remove all old unnecessary components.

Services & processing

N/A

Data and persistence

N/A

AzmiTouil commented 2 weeks ago

Ready for Tech review by DAO members (cc @rdenarie )

srenault-meeds commented 2 weeks ago

And ready for func review @margondicco :)

margondicco commented 2 weeks ago

Hello thank you and well done ! Go Fonc. :-)

rdenarie commented 2 weeks ago

Go tech, thanks