F7 prop: PContributionSurvey v.01 - Requirements

[DanM3rcurius]

Personal Contribution Survey (PCS) - Requirements v.01

To Do's

• [ ] Mock Up for template population @DanM3rcurius

Background

The Personal Contribution Survey (PCS) is currently a YAML template that is manually issued by each core contributor each month.

user story no.1

As a core contributor, I don't need to worry about aggregating the tasks I worked on, as long as I document what I'm doing in GitHub. Each month I get a notification that my Personal Contribution Survey is ready for me to verify. All my work from that month is aggregated in the Contribution Survey. All I need to do is specify my hourly rate and the hours worked that month, as well as to @mention at least one of the peers I worked with.

specs

• automatically create Personal Contribution Survey (PCS) via GitHub Actions (cronjob), on the first of each month for the previous one
• Pre fill PCS with following data

Datasource	Display type	info
Git(Hub)	Date:	date joined (check first contribution survey of each member)
Git(Hub)	Contributed to:	"repos" worked on
Git(Hub)	Output: <what IDs(#)>	what has been produced
SourceCred	Community Currency earned:	Can-D earned this month
Git(Hub)	Additional expenses: @	take into account all issues marked "expenses" and assigned to member

• assign PCS to respective core contributor

TestCases

TBD

user story no.2

At the end of each month, I submit my clockify data (to GitHub) and (after no longer than 24h) receive my Personal Contribution Survey for me to verify. All that's left for me to do is to @mention at least one of the peers I worked with.

Specs

• create clockify data input mechanism
• Pre fill PCS with following dataautomatically create Personal Contribution Survey (PCS) via GitHub Actions (cronjob), on the first of each month for the previous one

Datasource	Display type	info
Git(Hub)	Date:	date joined
Git(Hub)	Contributed to:	"repos" worked on
Git(Hub)	Output: <what IDs(#)>	what has been produced
SourceCred	Community Currency earned:	Can-D earned this month
GitHub	Additional expenses: @	take into account all issues marked "expenses" and assigned to member

• assign PCS to respective core contributor

TestCases

• Submit clockify data
• verify clockify data is correct in PCS

user story no.3

At the end of each month, I submit my clockify data (to a Discord Bot) and shortly after receive my Personal Contribution Survey for me to verify. All that's left for me to do is to @mention at least one of the peers I worked with.

Specs

• create PCS upon delivery of Clockify data

• Pre fill PCS with following data	Datasource	Display type	info
  Git(Hub)	Date:	date joined	automatically create Personal Contribution Survey (PCS) via GitHub Actions (cronjob), on the first of each month for the previous one
  Git(Hub)	Contributed to:	"repos" worked on
  Git(Hub)	Output: <what IDs(#)>	what has been produced
  SourceCred	Community Currency earned:	Can-D earned this month
  GitHub	Additional expenses: @	take into account all issues marked "expenses" and assigned to member

• assign PCS to respective core contributor

TestCases

TBD

[DanM3rcurius]

Hourly rate can't be set in BASIC clockify sub. Hourly rate has to be set manually @mbaldwin2015

[DanM3rcurius]

Clockify API docu https://clockify.me/developers-api @mbaldwin2015

[DanM3rcurius]

Call w @mbaldwin2015 , following mini milestones to be tackled:

1. create auto and assign PCS

2. user data from github; grab "tasks worked" on

3. clockify submit mechanism

4. create survey, pull tasks and clockify data together

[DanM3rcurius]

@dgarey checking out the reports now.

• Is it possible to omit (or delete on the spot) empty reports
• tag "weekly report" is used, but time shows only 1 day?
• why only reports from 3rd July and 28th June are showing?
• as I understand the report, it only crawls the documentation repo, can we change that?

[DanM3rcurius]

@dgarey Would it be possible to have the title above filled in for each PCS, so that the one above reads: "2022-06-dgarey-SecretDecks-Contribution Survey" ?