inukshuk / jekyll-scholar

jekyll extensions for the blogging scholar
MIT License
1.13k stars 101 forks source link

maintainance? #333

Open igravious opened 3 years ago

igravious commented 3 years ago

Already using Jekyll-Scholar and interested to help out? Please get in touch with us if you would like to become a maintainer!

I would like to become a maintainer.

inukshuk commented 3 years ago

That's great! In general, the project has been in maintenance-only mode for some time now -- which is fine, I think, though there are some interesting feature proposals/requests scattered around the issue tracker. I'm the original author of the plugin, but I never actively used it myself, so over the years most features were either suggested or contributed by users who've also helped with maintenance tasks, answering questions and so forth.

We don't have a fixed policy around here, but we've pretty much been following the 'open open source' approach, that is you earn write permissions when you make a few useful commits to the repository. I'm always happy to help if you have any questions.

igravious commented 3 years ago

I've started a Jekyll blog. I used to use a self-hosted Wordpress. Because I program in RoR I decided why not move to Jekyll. I have a couple of academic projects on the go. All my references are in Zotero. I use Better-BibTeX. I figure over the course of the next few years I'll be a doing a lot of scholarly blogging.

Tell me where to start and I'll go from there. The only thing is that I'm not familiar with the test-suite you use, you might bring me up to speed on that?

inukshuk commented 3 years ago

The test setup is very old, based on the Cucumber tests that Jekyll itself used originally; we use it mostly to catch regressions, because it's otherwise hard to keep track of all the different features or tweaks that have accumulated over the years. If there are any issues with it, it's probably that the dependencies are outdated nowadays.

Cucumber may not be in vogue anymore, but it's a good fit for our purpose because it allows us relatively easily to turn issue reports into tests. The feature DSL should be almost self-explanatory: it's based on a handful of step definitions. It's basically just a lot of pattern matching to set up scenarios (using the 'Given' sentences) and tests (the 'Then' sentences).

igravious commented 3 years ago

Cool. Gotcha. Okay, tell me where to start and I'll go from there.

inukshuk commented 3 years ago

I think the best place to start, if you want to work on something concretely, is to browse the open issues to see if there's anything that interests you.