image-sequencer icon indicating copy to clipboard operation
image-sequencer copied to clipboard

"Feature maintainers" groups to collaboratively manage IS

Open rishabhshuklax opened this issue 5 years ago • 44 comments

Similar to the one discussed in publiclab/plots2#6501 we should have maintainers groups in IS to collaboratively manage different features of IS this would help in maintaining the library more efficiently, Features around which we can develop a team around includes:

  • [ ] core-maintainers: GOALS: Stability and optimization of the core library. CURRENT PRIORITIES: Fix deprecated libraries. eg: readPixels and savePixels are actually not maintained and in fact, do not work at all for GIFs.

  • [ ] module-maintainers: GOALS: Increasing the number of modules, stability/optimization of existing modules. Ensuring that creating new modules remains easy and accessible and well documented. Developing and maintaining compelling use-cases for IS, as in #1480. CURRENT PRIORITIES: Increasing module GIF support and fixing bugs.

  • [ ] ui-maintainers GOALS: Stability and performance. CURRENT PRIORITIES: Fixing UI bugs and perhaps refactoring some of the old, unmanageable code.

  • [ ] tests-maintainers: GOALS: Increasing test coverage. CURRENT PRIORITIES: Increasing UI test coverage. Module and GIF tests are messy and decoupled, this needs to change as these tests are breaking unexpectedly.

  • [ ] cli-maintainers: GOALS: maintain existing features and expand test suite. CURRENT PRIORITIES: completing initial CLI test suite and covering all basic usages

What do you guys think?

@publiclab/is-reviewers @publiclab/support @publiclab/mentors

cc: @jywarren

rishabhshuklax avatar Feb 19 '20 17:02 rishabhshuklax

This is an awesome idea.

harshkhandeparkar avatar Feb 20 '20 11:02 harshkhandeparkar

Agreed!

jywarren avatar Mar 03 '20 16:03 jywarren

@jywarren there are many cooked bug fix PRs which have not been merged. And you are very busy I see. Can I get temporary merge permissions to continue with the bug fix event?

harshkhandeparkar avatar Mar 09 '20 13:03 harshkhandeparkar

Hi @HarshKhandeparkar it has been really tough to keep up. Do we have a prioriy or urgent label you can highlight them to me on? And, you can always bump them up to me in https://gitter.im/publiclab/publiclab -- thank you so much! Hope everyone is safe and doing well. ❤️

jywarren avatar Apr 14 '20 21:04 jywarren

I think almost all PRs are outdated and inactive at this point 😅.

harshkhandeparkar avatar Apr 15 '20 06:04 harshkhandeparkar

Hi @HarshKhandeparkar after #1668 perhaps we can get ahead of this again now! It dramatically simplifies the review process. Thank you and hope you're well!

jywarren avatar Jul 05 '20 22:07 jywarren

though, noting https://github.com/publiclab/image-sequencer/issues/1681 as well...

Update: fixed!! 🎉

jywarren avatar Jul 05 '20 22:07 jywarren

It works really well!

harshkhandeparkar avatar Jul 08 '20 16:07 harshkhandeparkar

Thanks for all the reviews and issue cleanup!

jywarren avatar Jul 10 '20 18:07 jywarren

Ah, thought of a new one -- cli-maintainers -- pending the CLI tests in #1694

jywarren avatar Oct 01 '20 18:10 jywarren

Can folks volunteer for a specific one and we can start creating the CODEOWNERS listing? Thank you all!!!

jywarren avatar Oct 01 '20 18:10 jywarren

I could help out in maintaining modules and core functionalities, while working on #1564 I had to go through a lot of code related to these

rishabhshuklax avatar Oct 01 '20 18:10 rishabhshuklax

definitely module and core! I love cli but idk what changes can be made to it ¯_(ツ)_/¯

harshkhandeparkar avatar Oct 01 '20 19:10 harshkhandeparkar

Cool, thanks both! I guess we ought to write a line of description of the "goals" and "priorities" of each. Harsh, for CLI, my thought is not every feature needs planned changes -- some can be in "maintenance" status, meaning the maintainers for that feature are primarily ensuring that it remains stable and undisrupted, and perhaps slowly increasing test coverage of it. Make sense?

Whereas the "modules" maintainers might be seeking both to increase the # of modules, and to increase stability/test coverage of existing ones -- it's up for discussion!

On Thu, Oct 1, 2020 at 3:15 PM Harsh Khandeparkar [email protected] wrote:

definitely module and core! I love cli but idk what changes can be made to it ¯(ツ)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/image-sequencer/issues/1633#issuecomment-702343430, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6J7G3Y6B4U5WKTMPF7LSITIOTANCNFSM4KX5KBJQ .

jywarren avatar Oct 01 '20 22:10 jywarren

Awesome, @daemon1024 is working on an initial CLI test suite and is interested in being a feature maintainer for the CLI featureset, whose goal is maintain existing features and expand test suite. Awesome!

OK, if we can get some similar descriptions/goals for other featuresets, we can create the initial CODEOWNERS file. Thanks, all!

  • [ ] core-maintainers - goals: GOALS HERE: @blurry-x-face @HarshKhandeparkar
  • [ ] ui-maintainers - goals: maintain and refine existing demo UI, expand test coverage, use generic UI CSS classes to enable other UIs to be tested against if possible, maintain separation of UI code from rest of codebase:
  • [ ] tests-maintainers - goals: expand and maintain test suites and related documentation, increase coverage:
  • [x] cli-maintainers - goals: maintain existing features and expand test suite: @daemon1024
  • [ ] module-maintainers - goals: GOALS HERE: @blurry-x-face @HarshKhandeparkar

What do we think about core goals or test or module goals? I think core ought to be "stability, optimization, backwards-compatibility" maybe?

Modules... one could be "making sure it's simple to create new modules" and "standardizing module code and documentation"

Tests... maybe "ensure test parity across various use cases including CLI, Node, and browser"? and more?

jywarren avatar Oct 06 '20 18:10 jywarren

Should we add this list of goals to the issue body?

harshkhandeparkar avatar Oct 06 '20 20:10 harshkhandeparkar

Anyone here can edit and add the goals.

harshkhandeparkar avatar Oct 06 '20 20:10 harshkhandeparkar

I believe core should be "stability, performance and future compatibility". I think we are just breaking IS further due to backwards compatibility and no one uses old browsers with IS anyway. And also, some parts of IS are anyway not compatible with old browsers and node <10 ig.

harshkhandeparkar avatar Oct 06 '20 20:10 harshkhandeparkar

Oh sorry, so this is a good reason to write these together -- i should clarify - i meant backwards compatibility as in no breaking changes and no adverse effects on existing functions, including core, modules, ui and cli. And yes, we can keep compiling these at the top!

jywarren avatar Oct 06 '20 20:10 jywarren

@jywarren I have added some of the goals and priorities to the issue body, please check it out :)

cc: @blurry-x-face @daemon1024

harshkhandeparkar avatar Oct 07 '20 11:10 harshkhandeparkar

The priorities are absolutely tentative, I just wrote whatever came to my mind.

harshkhandeparkar avatar Oct 07 '20 11:10 harshkhandeparkar

OK awesome i like them a lot. I propose for module goals:

GOALS: Increasing the number of modules, stability/optimization of existing modules.

to add: also, ensuring that creating new modules remains easy and accessible and well documented

And: "developing compelling use cases for sequences to show off IS functionality, as in #1480"

what do you think?

jywarren avatar Oct 07 '20 14:10 jywarren

Sure, I'll add it.

harshkhandeparkar avatar Oct 07 '20 15:10 harshkhandeparkar

Umm, should child teams of is-maintainers be made? We can add these priorities and goals there.

harshkhandeparkar avatar Oct 07 '20 16:10 harshkhandeparkar

Hmm, cool idea! Yes, we can do that - like is-module-maintainers, is-core-maintainers? Also, i forget if whole teams can be made CODEOWNERS...

also maybe interesting --

"round robin" auto review requests to prompt only some people in a team! https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team=

also really nice "review request scheduling reminders" system here: https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-your-team

maybe useful if teams get bigger, and/or if people don't want to be on the hook all the time but just a proportion!

On Wed, Oct 7, 2020 at 12:20 PM Harsh Khandeparkar [email protected] wrote:

Umm, should child teams of is-reviewers be made? We can add these priorities and goals there.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/image-sequencer/issues/1633#issuecomment-705046282, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6J7NT5EPJEDWBJ4DVT3SJSINDANCNFSM4KX5KBJQ .

jywarren avatar Oct 07 '20 16:10 jywarren

I think teams can be codeowners according to this official blog post. https://github.blog/2017-07-06-introducing-code-owners/ image That(github/js) looks like a team

harshkhandeparkar avatar Oct 07 '20 17:10 harshkhandeparkar

Awesome. Anyone else @publiclab/is-reviewers want to join a maintainers team? Any last changes before we start this up? Thanks!!!

On Wed, Oct 7, 2020 at 1:28 PM Harsh Khandeparkar [email protected] wrote:

I think teams can be codeowners according to this official blog post. https://github.blog/2017-07-06-introducing-code-owners/ [image: image] https://user-images.githubusercontent.com/34770591/95366088-9468c700-08f0-11eb-97eb-52aa0e240d06.png That(github/js) looks like a team

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/image-sequencer/issues/1633#issuecomment-705084233, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6J2V7ALYZJQBF4MCJM3SJSQMRANCNFSM4KX5KBJQ .

jywarren avatar Oct 07 '20 21:10 jywarren

If @blurry-x-face confirms the list then ig we are good to go.

harshkhandeparkar avatar Oct 08 '20 19:10 harshkhandeparkar

Yea @HarshKhandeparkar goals and pririties looks good to me, we can continue with this :)

rishabhshuklax avatar Oct 08 '20 19:10 rishabhshuklax

Great -- Harsh, would you like to open a PR with the CODEOWNERS file accordingly, and i can review and make the corresponding teams? Thanks, all!

On Thu, Oct 8, 2020 at 3:06 PM Rishabh Shukla [email protected] wrote:

Yea @HarshKhandeparkar https://github.com/HarshKhandeparkar goals and pririties looks good to me, we can continue with this :)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/image-sequencer/issues/1633#issuecomment-705764987, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6JZC6PGCLK72NSYT7UDSJYESNANCNFSM4KX5KBJQ .

jywarren avatar Oct 08 '20 21:10 jywarren