search

Everduin94 / better-commits

A CLI for creating better commits following the conventional commits specification
MIT License
1.96k stars 69 forks source link

Config Explanation Table (Readme) #26

Closed Everduin94 closed 1 year ago

Everduin94 commented 1 year ago

A table should be added to the Readme that explains what each property does

This would be a good first time issue / help wanted

I can fill in any gaps or help with any explanations if someone else ends up picking this up

bhanudatsinhjhala commented 1 year ago

I want to contribute. Can you please assign me? @Everduin94

Everduin94 commented 1 year ago

@bhanudatsinhjhala - Hey sorry for the late reply, I was on vacation :)

You can fork and give it a shot, there's no official rules here about assigning haha. Thanks for wanting to contribute, I appreciate it :)

To add more context, I'm thinking the table should be something like this.

Property Description
property-name-here a short description of what it does

If the property name is nested in an object like commit_type: { enable } then write it like this as the property name: commit_type.enable.

Does that all make sense? -- Even if you're not sure what something does, just building out the structure of the table for me to fill in would be very helpful.

bhanudatsinhjhala commented 1 year ago

Hey, now I'm going on vacation from tomorrow. I will understand what you want. I will do it after I comeback from vacation.

On Wed, 9 Aug, 2023, 8:13 pm Erik Verduin, @.***> wrote:

@bhanudatsinhjhala https://github.com/bhanudatsinhjhala - Hey sorry for the late reply, I was on vacation :)

You can fork and give it a shot, there's no official rules here about assigning haha. Thanks for wanting to contribute, I appreciate it :)

To add more context, I'm thinking the table should be something like this. Property Description property-name-here a short description of what it does

If the property name is nested in an object like commit_type: { enable } then write it like this as the property name: commit_type.enable.

Does that all make sense? -- Even if you're not sure what something does, just building out the structure of the table for me to fill in would be very helpful.

— Reply to this email directly, view it on GitHub https://github.com/Everduin94/better-commits/issues/26#issuecomment-1671536698, or unsubscribe https://github.com/notifications/unsubscribe-auth/AP5PAG3DJFJH3A7263HTSEDXUOO2NANCNFSM6AAAAAAWPEUFUU . You are receiving this because you were mentioned.Message ID: @.***>