Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Looking for maintainers / contributors / code reviewers... #1678

Open
isagalaev opened this issue Jan 17, 2018 · 51 comments
Open

Looking for maintainers / contributors / code reviewers... #1678

isagalaev opened this issue Jan 17, 2018 · 51 comments
Labels
big picture Policy or high level discussion good first issue Should be easier for first time contributors help welcome Could use help from community

Comments

@isagalaev
Copy link
Member

The project was dormant for a while because none of the current nominal maintainers has enough time/motivation to do the job. Hence, the project is looking for a new maintainer (or several).

Involvement

Ideally I would gladly hand the project over completely to a new principal maintainer, provided they're interested in keeping it roughly within the same principles it's been following the past 10 years. It would be a real letdown for existing users if the project suddenly pivoted into something else.

Realistically though, since I am probably still the only person intimately familiar with the core engine, we could probably make it work with shared maintenance. We can work out the details down the road.

My ultimate goal here is to stop being a bottleneck.

Revival plan

Another reason why the project got hard to maintain is that it's outgrown a few old assumption and is in need of reworking to bring it back into maintainable state. Roughly:

  • Our build process with several build targets and customizable sets of languages is a pain for both maintainers and users. Since we now live in the world with HTTP/2 and evolved JavaScript packaging it needs to be replaced. I can be instrumental in describing the pain points and historical perspective, but I don't know shit not familiar with modern JS infrastructure.

  • It might make sense to severely limit the set of languages supported within the main repository, with others moving outside for community support, hosted somewhere else. For that the API between the library and languages needs to (finally) be stabilized.

Migration

  • We should migrate the project under the org https://github.com/highlightjs/, forking it from here. I don't have a good idea what to do with all the open issues on this repo under /isagalaev/. One way could be defaulting on all of them here and asking interested people to reopen them at the new location.

  • I own highlightjs.org and happy to keep it running for now, but if we decide on handing over maintenance completely, the domain should probably go to the new maintainer as well.

  • There's also a Twitter account @highlightjs which I don't want to care about anymore and a Google group which might be simply deleted due to lack of traffic/purpose.

Anyone?

A few people have already pinged me over email, so please reiterate your intention here, to which degree you're interested in helping out/taking over.

And thank you!

@ddevault
Copy link
Contributor

Hey @isagalaev, glad you're taking this step for the health of the project. I would be happy to volunteer. I do not have time to work on extended development on the project, but I do have time for maintainership - holding the vision in my head and applying to reviewing pull requests, providing feedback on them, and merging and releasing them.

I agree with your driving principles and I will happily use them as a guide for my work here.

Our build process with several build targets and customizable sets of languages is a pain for both maintainers and users. Since we now live in the world with HTTP/2 and evolved JavaScript packaging it needs to be replaced. I can be instrumental in describing the pain points and historical perspective, but I don't know shit not familiar with modern JS infrastructure.

This is a good idea, and shouldn't be terribly difficult.

We should migrate the project under the org https://github.com/highlightjs/, forking it from here. I don't have a good idea what to do with all the open issues on this repo under /isagalaev/. One way could be defaulting on all of them here and asking interested people to reopen them at the new location.

You can move the repo to a new org without making a fork, keeping all of the issues and pull requests. I agree that an org is the right home for highlight.js given the refactoring plans. These repos:

It might make sense to severely limit the set of languages supported within the main repository, with others moving outside for community support, hosted somewhere else. For that the API between the library and languages needs to (finally) be stabilized.

Could live there.

There's also a Twitter account @highlightjs which I don't want to care about anymore and a Google group which might be simply deleted due to lack of traffic/purpose.

FWIW I don't have any interest in maintaining either of these.

@ldct
Copy link
Contributor

ldct commented Jan 17, 2018

Hi @isagalaev, as mentioned over email, I'd be happy to help maintain this. The 2 priorities listed in the revival plan make sense to me and would be what I'd focus on doing.

@duncdrum
Copy link
Contributor

@isagalaev I m in the same boat as SirCmpwn.
Moving the repo to highlight.js org here on github shouldn't be a problem.
As for trimming rare languages there are already a number of good libraries with such a limited support. "Community support" looks great on paper, but in practice I fear that such an outsourcing of languages will lessen the appeal of highlight.js and create more maintenance hassles than its worth.

@idleberg
Copy link
Contributor

idleberg commented Jan 23, 2018

It might make sense to severely limit the set of languages supported within the main repository, with others moving outside for community support, hosted somewhere else.

Making such a limitations will always be subjective choice, so why not make it fully modular and leave the choice to the user? I'd (still) like to see an officially maintained package on npm and single languages could be easily be published as single packages under an organization account (e.g. @hljs.)

Example:

# Install typical web languages
npm i @hljs/core @hljs/html @hljs/css @hljs/js

I've contributed nsis.js several years ago and I'm interested in maintaining it in the future.

@shiya
Copy link
Contributor

shiya commented Jan 23, 2018

I'd really like to help because this is such a good library and I've been using it at several places. I have some time to spare but not sure where to get started.

@sangdth
Copy link

sangdth commented Jan 25, 2018

I'm not looking to take over, but I would like to help.

@Duncanma
Copy link

I'm interested in helping, I'd even be up for handling the twitter account :) (I ran the one for channel9.msdn.com for 5 or 6 years)

@isagalaev
Copy link
Member Author

Just to give you guys a status update: I'm sitting silent simply to collect all the shout outs for now. I think I'll move the repo and flesh out a few tasks this weekend, so stay tuned!

And thanks a lot, everyone!

@tracker1
Copy link

I'd be happy to participate in the new org... though not sure how much I would contribute beyond reviewing and merging/publishing pull requests. I don't have enough time to participate in the refactoring for separating languages, though would really like to be.

@PatrickMassot
Copy link

Are there any news on this issue? My real question is: how plausible it is that the queue of PR adding new languages will be flushed soonish? Note that I'm not complaining about anything, I only try to get some insight.

@ddevault
Copy link
Contributor

ddevault commented Feb 8, 2018

I wonder if the best course of action would be to establish a GitHub org and grant all of the volunteers the rights necessary to execute maintainership duties? There needn't necessarily be a single maintainer - more would make the workload easier to handle.

@isagalaev
Copy link
Member Author

I wonder if the best course of action would be to establish a GitHub org and grant all of the volunteers the rights necessary to execute maintainership duties?

Yes, that's the plan. I haven't yet gotten to it because I wanted to write a minimal maintainer's guide with dos and don'ts accumulated over the years. Without one I am bound to remain a bottleneck, this time as a reviewer.

Please be patient! :-)

@gusbemacbe
Copy link
Contributor

@isagalaev

Hi and good morning, I am sorry for sending many same comments to someboy in the iusses and pull requests because I thoght you passed away, but I want to suggest you, so I talked with one of contributors.

I suggest that you talk with Microsoft maintainers (https://github.com/Microsoft/vscode) and its major maintainers are @bpasero, @joaomoreno, @sandy081 and @Tyriar because they use officialy this repository for VSCode for converting Markdown to HTML. Every month Microsoft updates the version of VSCode Insiders, merging hundred or thousands pull requests.

You can find the directory of Highlight.js in the director of an app VSCode. In Linux /usr/share/code/resources/app/extensions/markdown-language-features/node_modules/highlight.js/. In Mac: Visual Studio Code.app/Contents/Resources/app/extensions/markdown-language-features/node_modules/highlight.js. As for Windows, I do not know, because I do not use Windows.

@Tyriar
Copy link

Tyriar commented Apr 15, 2018

+@mjbvz

@gusbemacbe
Copy link
Contributor

@Tyriar, has @mjbvz spoken with @isagalaev ?

@mjbvz
Copy link

mjbvz commented May 17, 2018

Sorry but this is not something I'm interested in. Our usage in highlight js is quite limited. We only use it in the markdown preview, and use it there mainly because many websites also use it for syntax coloring

@ddevault
Copy link
Contributor

Yes, that's the plan. I haven't yet gotten to it because I wanted to write a minimal maintainer's guide with dos and don'ts accumulated over the years. Without one I am bound to remain a bottleneck, this time as a reviewer.

I feel like we might have figured it out by now

@isagalaev
Copy link
Member Author

True, and sorry for letting everyone down. Let me find some free evening this week (Wednesday most likely) to just move it over and unblock things.

@ddevault
Copy link
Contributor

Thank you!

@isagalaev
Copy link
Member Author

OK, let me try this again…

I moved the project over to the new place https://github.com/highlightjs/highlight.js and invited @SirCmpwn as a new maintainer (since he prompted me to finally do it, so he's clearly still interested — thank you!). I kindly ask all the others who volunteered (@ldct, @idleberg, @shiya, @sangdth, @DuncanmaMSFT, @tracker1) to shout out if they're still interested, it's been half a year ago after all…

I put a very basic maintainer's guide in place, it'll probably grow to include something about governance. We didn't need it before, but will clearly need from now on.

Finally, I created a ticket for a new build system: #1759. I wouldn't go as far as to say that it's essential for the future maintenance of the project, but it's certainly something which only grows in importance with time.

@sangdth
Copy link

sangdth commented Jul 19, 2018

@isagalaev I'm still interested.

1 similar comment
@idleberg
Copy link
Contributor

@isagalaev I'm still interested.

@ddevault
Copy link
Contributor

Thanks @isagalaev! I invited @sangdth and @idleberg as well.

Let me restate my original offer:

I would be happy to volunteer. I do not have time to work on extended development on the project, but I do have time for maintainership - holding the vision in my head and applying to reviewing pull requests, providing feedback on them, and merging and releasing them.

I still don't have time to do extended development on the project, but I'm going to turn my focus towards the huge backlog of pull requests (122!) we have to get through.

@ldct
Copy link
Contributor

ldct commented Jul 19, 2018

@isagalaev I'm still interested

@isagalaev
Copy link
Member Author

@isagalaev, could you kindly add @gmmorris to the contributors?

Done. I also fixed your role to owner, so you can do that too. I was fairly sure everyone I added was oener already, but apparently I missed something.

Also, could you give "marcosc" the ability publish on npm?

This is supposed to happen automatically when a new release is created (https://github.com/highlightjs/highlight.js/blob/master/docs/maintainers-guide.rst#release-process). And I think it makes sense to keep it this way so all updates happen everywhere simultaneously.

@marcoscaceres
Copy link
Contributor

Ok, cool. I'd missed that bit of the maintainers guide.

@isagalaev
Copy link
Member Author

Ok, cool. I'd missed that bit of the maintainers guide.

Also, when you guys decide to make a release, ping me from the release issue so I could look over the server. It should all happen automatically, but given that it wasn't exercised for over a year, some things may have rotten.

@marcoscaceres
Copy link
Contributor

Sounds great. Will do!

@joshgoebel
Copy link
Member

No interest in being "principal" maintainer, but I don't mind helping out from time to time with PRs and issues as I can.

@joshgoebel joshgoebel added other big picture Policy or high level discussion help welcome Could use help from community labels Oct 7, 2019
@joshgoebel joshgoebel removed the other label Dec 26, 2019
@joshgoebel joshgoebel pinned this issue Dec 26, 2019
@joshgoebel
Copy link
Member

joshgoebel commented Feb 6, 2020

And just FYI: if becoming a maintainer is "scary" for anyone who's maybe never done that before or a little commitment shy... then you don't have to step up and say "I'll be a maintainer" or make a huge commitment... There is no official swearing in process required to make a pull request or help out here and there on issues.

There are plenty of PRs tagged with help welcome or beginner... if all you do is drop by and contribute a single PR or two (or help with communication on issues), that would still be greatly appreciated... and maybe you end up staying longer and contributing more, maybe not.

Personally I started with one PR, then another, then eventually 20 more...; and then eventually it made sense to add myself as a listed maintainer in AUTHORS.

Just wanted to encourage others: you can start small if you want and see where it takes you. :-)

@NotMoni
Copy link

NotMoni commented May 6, 2020

If it's still possible. I am ready to help and maintain. 🦄

@joshgoebel
Copy link
Member

joshgoebel commented May 6, 2020

Cool. You could start by cutting your teeth on some of the easy to get started tagged issues:

Or if there is anything specific you're interested in, let me know. The huge CSS consolidation work could use some time invested.

@NotMoni
Copy link

NotMoni commented May 6, 2020

Sure mate

@joshgoebel
Copy link
Member

Any objections to posting on https://adoptoposs.org ? I just saw this.

@egor-rogov
Copy link
Collaborator

Any objections to posting on https://adoptoposs.org ? I just saw this.

I wouldn't expect it to help find enthusiasts, but why not?

@allejo
Copy link
Member

allejo commented May 20, 2020

Any objections to posting on adoptoposs.org ? I just saw this.

No objections here. I hope something comes out of this 😅

@joshgoebel joshgoebel changed the title Looking for maintainer(s) Looking for maintainers Jul 21, 2020
@joshgoebel joshgoebel changed the title Looking for maintainers Looking for maintainers & contributors Sep 21, 2020
@joshgoebel joshgoebel changed the title Looking for maintainers & contributors Looking for maintainers / contributors / code reviewers... Nov 11, 2020
@joshgoebel joshgoebel added the good first issue Should be easier for first time contributors label Apr 13, 2021
@bradleymackey
Copy link
Contributor

Happy to help with some basic PR maintenance: approving PRs runs, closing PRs for new core grammars (with suggestion to add to the third party list) and validating/closing issues.

@techbabe23
Copy link

Hi, seeing that this issue is still open are you still looking for maintainers/contributors/code reviewers?

@isagalaev
Copy link
Member Author

Hi, seeing that this issue is still open are you still looking for maintainers/contributors/code reviewers?

Hey! I'm not in a position to answer your question myself, but last I know the discussion was now happening in Discord https://discord.gg/M24EbU7ja9, so you may have more luck asking over there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big picture Policy or high level discussion good first issue Should be easier for first time contributors help welcome Could use help from community
Projects
None yet
Development

No branches or pull requests