search

derlin / bitdowntoc

Online and command-line Markdown TOC generator, with built-in support for BitBucket Server, GitHub, Gitlab, dev.to and more!
https://bitdowntoc.derlin.ch
Other
87 stars 8 forks source link

fix minor typos in README #41

Closed 0xdevalias closed 6 months ago

0xdevalias commented 6 months ago

Fixed a few minor typos I noticed in the README

derlin commented 6 months ago

That's great, thank you! However, I also missed your suggestion on #39 so I propose #42 instead. Is this ok with you?

0xdevalias commented 6 months ago

so I propose #42 instead. Is this ok with you?

@derlin Generally speaking, if this were my project, I would have either:

One downside of your current proposal is that #42 doesn't actually contain any commits from me, so aside from the note on the PR itself, it basically erases my contribution from the commit history, which I tend to view as somewhat 'anti-contributor'.

Ultimately though, it's your project, and therefore your decision.

derlin commented 6 months ago

@0xdevalias This is a very good point and a bad move from my end. Thanks for speaking out!

Your contribution should indeed be celebrated. May I ask you to change the commit message to match the conventional commits? I would propose docs: fix typos in readme (so it shows in the CHANGELOG, whereas chore doesn't). Will merge once this is done, and rebase my PR on yours.

0xdevalias commented 6 months ago

This is a very good point and a bad move from my end. Thanks for speaking out!

Your contribution should indeed be celebrated. May I ask you to change the commit message to match the conventional commits? I would propose docs: fix typos in readme (so it shows in the CHANGELOG, whereas chore doesn't). Will merge once this is done, and rebase my PR on yours.

@derlin Awesome, can do :)

0xdevalias commented 6 months ago

@derlin Dropped your merge commit + rebased on latest main + changed my commit message as suggested above. Should be good to go now I think.