community icon indicating copy to clipboard operation
community copied to clipboard

exclude emeritus from voting overview

Open derberg opened this issue 1 year ago • 35 comments

we show voting overview in https://github.com/asyncapi/community/blob/master/TSC_VOTING_OVERVIEW.md

data file is here: https://github.com/asyncapi/community/blob/master/voteTrackingFile.json

all implementation details are in: https://github.com/asyncapi/community/pull/1278

the thing is that we should not show in the voting overview people that are no longer TSC members but emeritus

example of person that is visible in voting, but no longer tsc member: https://github.com/asyncapi/community/blob/master/MAINTAINERS.yaml#L194

cc @AayushSaini101 who might guide you with the work

derberg avatar Nov 28 '24 08:11 derberg

I would like to work on this issue. Please assign it to me if no one else's working

kaneki003 avatar Dec 21 '24 18:12 kaneki003

hello @derberg [ lukasz ], i see the issue not completed by previous contributer, can work on it.

rohithyarramala avatar Apr 01 '25 14:04 rohithyarramala

sure but https://github.com/asyncapi/community/pull/1837 needs to be merged first. The current code is a mess, refactor is needed. So plan to to get each function one by one properly tested

derberg avatar Apr 01 '25 16:04 derberg

sure @derberg , is i need to wait for its merge or work on this , by refer to the #1837 changes ,

rohithyarramala avatar Apr 02 '25 11:04 rohithyarramala

yeah, and don't see any other option than waiting - maybe you can already do some pseudo code, or some preps, I don't know

derberg avatar Apr 02 '25 14:04 derberg

@Nandgopal-R do you still want to continue with this topic after https://github.com/asyncapi/community/pull/1837 is merged? or not really?

derberg avatar May 19 '25 11:05 derberg

If @Nandgopal-R can't continue, I can look ahead

rohithyarramala avatar May 20 '25 12:05 rohithyarramala

@rohithyarramala lets give @Nandgopal-R like time until the end of Thursday to respond - as he was first and alrady did some good stuff. We are not in a rush. If he doesn't respond, on friday this one is yours

derberg avatar May 20 '25 16:05 derberg

@Nandgopal-R do you still want to continue with this topic after #1837 is merged? or not really?

Ya, sure! I’d like to continue with it

Nandgopal-R avatar May 21 '25 14:05 Nandgopal-R

@Nandgopal-R , ok bro , thanks for reply

rohithyarramala avatar May 31 '25 08:05 rohithyarramala

@rohithyarramala go ahead, I see no new PR in that topic

derberg avatar Jun 02 '25 15:06 derberg

and just clarify, next PR should address further refactoring, like in previous PR from @Nandgopal-R

open to your suggestions what that could be

one function per PR to make review super easy

derberg avatar Jun 02 '25 15:06 derberg

seems good about one function per PR ,

i will start work from 4 th , had some exams in b/w , and after analysis i will tell you my plan of action and get to know your suggestion. @derberg thank you

rohithyarramala avatar Jun 02 '25 17:06 rohithyarramala

Ok @derberg , this will be taken care by @rohithyarramala right?

Nandgopal-R avatar Jun 06 '25 03:06 Nandgopal-R

Hello @derberg, I saw that https://github.com/asyncapi/community/blob/master/TSC_VOTING_OVERVIEW.md has changed. Is the issue resolved or has the file been renamed? to another name.

rohithyarramala avatar Jun 15 '25 17:06 rohithyarramala

Here, there is no voting overview. Does this need work or was it skipped

rohithyarramala avatar Jun 15 '25 17:06 rohithyarramala

yeah, so reorg was there, new location is: https://github.com/asyncapi/community/blob/master/docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md

so yeah, your first PR could be to make sure automation is aware of new location :)

derberg avatar Jun 16 '25 11:06 derberg

@Nandgopal-R there is a lot of work here, you can share workload, even work in pair. You know very well how much refactor is needed. Please folks just transparently communicate here in issue on time with info who modifies which part of the code

derberg avatar Jun 16 '25 11:06 derberg

Yeah, we can share @derberg.

rohithyarramala avatar Jun 16 '25 11:06 rohithyarramala

Yes sure @derberg

Nandgopal-R avatar Jun 16 '25 12:06 Nandgopal-R

@rohithyarramala how would you like to split the work?

Nandgopal-R avatar Jun 16 '25 12:06 Nandgopal-R

What is the exact issue is :

  1. Refactor the files
  2. Update the code such that, automatically updates the overview file

=> Refactor the file from your end @Nandgopal-R. => I will write the auto script to update the overview file. Is any else is included in this @derberg . Please confirm.

rohithyarramala avatar Jun 16 '25 13:06 rohithyarramala

Process Approach, for @Nandgopal-R => based on the https://github.com/asyncapi/community/blob/master/MAINTAINERS.yaml, update https://github.com/asyncapi/community/blob/master/docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md.

for @rohithyarramala => make a GitHub action, On update maintainers. Yaml update the overview.md

@derberg, this is my observation: if you find my approach and issues correct, please confirm, we will start, and please tell your acceptance @Nandgopal-R

rohithyarramala avatar Jun 16 '25 13:06 rohithyarramala

@rohithyarramala yes this works mate, we can start as soon as @derberg approves it.

Nandgopal-R avatar Jun 16 '25 14:06 Nandgopal-R

wait wait, but GH action is there, and code is there - just a bit spaghetti, not tested, and needs refactor

https://github.com/asyncapi/community/blob/master/docs/020-governance-and-policies/TSC_VOTING_OVERVIEW.md is updated by https://github.com/asyncapi/community/blob/master/.github/workflows/vote-tracker.yml action that runs this code https://github.com/asyncapi/community/tree/master/.github/scripts/vote_tracker

with help from @Nandgopal-R first util was extracted, and testing setup was done https://github.com/asyncapi/community/blob/master/test/vote_tracker.test.js

so basically more functions must be extracted/refactored/single-scoped so they can be properly tested, and we can make code much easier to understand and extend with more functionality. Extracted from https://github.com/asyncapi/community/blob/master/.github/scripts/vote_tracker/index.js just like isVotingWithinLastThreeMonths was.

I suggest below:

  • move jsonToMarkdownTable to utils and provide tests and jsdocs - so it is super easy to identify what is the structure of "data" so it is much easier to work with this helper. Maybe this helper could be simplified? maybe it actually requires to be split apart for easier testing? maybe should not be moved to utils.js because there will be few helpers and better move it to new markdown.js
  • move and refactor parseVoteClosedComment as you can already see there is a problem with this function as it doesn't operate on any input argument but depends on some variable out of function scope. So yeah, refactored, move, jsdoc and test
  • and so on, same for example with fetchCommentInformation and the others. Refactor, make smaller and scoped, jsdocs, tests, etc

Just pick one by one, all are on the same level of complexity

derberg avatar Jun 16 '25 14:06 derberg

Yeah, got the things, We have to make the thing one by one No need to do in pairs, because if one is implemented, others are in a chain of action, so doing any one is a better thing. I can do this alone. and submit a pr.

rohithyarramala avatar Jun 16 '25 17:06 rohithyarramala

I mean we each could do one each like how @derberg mentioned. I am ready to take the first one about jsontomarkdowntables if you are fine with it @rohithyarramala .

Nandgopal-R avatar Jun 16 '25 17:06 Nandgopal-R

exactly @Nandgopal-R, there is a lot of work there, the more people work on it, the better as the work will be done faster 😃 So just communicate who is working on what part and good luck with the work

derberg avatar Jun 16 '25 17:06 derberg

ok @Nandgopal-R, as you say, i start work on updateVoteTrackingFile

rohithyarramala avatar Jun 17 '25 12:06 rohithyarramala

hey @rohithyarramala and @Nandgopal-R , how is your progress?

derberg avatar Jul 29 '25 12:07 derberg