commitplease icon indicating copy to clipboard operation
commitplease copied to clipboard

Join forces with commitlint?

Open marionebl opened this issue 7 years ago • 8 comments

Hey there,

just learned about commitplease by chance. Thanks for making your work available!

I am the author of commitlint, a tool very similar to yours.

I wonder if we could join the efforts on both tools in some way?

marionebl avatar Oct 09 '17 07:10 marionebl

Hey, thanks for reaching out.

I've taken a very quick look at commitlint, it looks nice, you've clearly put a bit of effort into it. Here is a (not in any way complete or even correct) comparison:

  1. You use ES6 features, we don't
  2. You have your documentation split between github readme and github pages website. It gives an impression that your documentation is simpler (although it probably is not) when compared to our bulky readme. However, in our case everything is just in one place.
  3. You have more downloads/commits/activity than us. Good for you :+1:

What do you mean by "joining efforts" though? There are projects that depend on commitplease, so it is not going away any time soon. Also, there are even more interesting projects in the field of linting various stuff (no offence), look for instance at coala.

Also, I am not the author of commitplease, so you could wait for @jzaefferer's opinion as well I guess.

alisianoi avatar Oct 09 '17 12:10 alisianoi

To make this a bit clearer, my thoughts are:

  1. scopes are similar enough to think about code sharing
  2. there is non-trivial effort involved in maintaining each
  3. I can imagine lots of shades of collaboration, from listing each other as "related", over sharing config formats, sharing core libs up to merging into one tool.

Before investing the time to analyse the differences in detail I figured it would be sensible to ask for your thoughts on collaborating in general.

marionebl avatar Oct 09 '17 12:10 marionebl

I'm interested in collaboration. In general I don't think the JavaScript community needs more choice - less options of good tools is generally better. Like eslint now being pretty much the only tool for linting JS files, and that's a good outcome.

A few thoughts, not a detailed analysis:

  • commitplease has been around ~2 years longer, yet has less contributors and users
  • commitplease is an all-in-one, specialised package, but exposing an API for other modules to depend on. Config is a field in package.json
  • commitlint is much more distributed, asking the user to install at least two packages, a 3rd if they want git hook integration. Configuration is primarily a standalone JS file, and there's more options. Having a website is nice, though I find the ToC rather confusing

I'm not attached to commitplease as a project, but I like its simplicity in setting it up. I'm curious what you suggest.

jzaefferer avatar Oct 09 '17 14:10 jzaefferer

One more thing: If you take the time for a detailed analysis, I suggest you also check #62, #63 and #81.

jzaefferer avatar Oct 09 '17 14:10 jzaefferer

What I gather from your feedback is that there are the following dimensions worth focusing on during an analysis

  • Installation
  • Initial setup
  • Configuration formats
  • API
  • Documentation

For the time being I'd set aside internal stuff as implementation details, e.g.

  • Build system
  • CI setup
  • Tests

Thoughts, additions?

marionebl avatar Oct 10 '17 06:10 marionebl

Sounds good!

There might be some tests worth sharing, but since users won't care about that, it's much less important.

On Oct 10, 2017 08:14, "Mario Nebl" [email protected] wrote:

What I gather from your feedback is that there are the following dimensions worth focusing on during an analysis

  • Installation
  • Initial setup
  • Configuration formats
  • API

For the time being I'd set aside internal stuff as implementation details, e.g.

  • Build system
  • CI setup
  • Tests

Thoughts, additions?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jzaefferer/commitplease/issues/105#issuecomment-335371562, or mute the thread https://github.com/notifications/unsubscribe-auth/AADNac1Dk3RFg6_DJ-g7cnpWSJC9y4Ieks5sqwthgaJpZM4PyETy .

jzaefferer avatar Oct 10 '17 06:10 jzaefferer

@marionebl how's your interest in this?

jzaefferer avatar Feb 02 '18 10:02 jzaefferer

Still there, just swamped with other things!

marionebl avatar Feb 02 '18 11:02 marionebl