Skip to content

Documentation (CONTRIBUTING.md): add commit guide #198

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

Closed
avara1986 opened this issue Oct 16, 2020 · 5 comments
Closed

Documentation (CONTRIBUTING.md): add commit guide #198

avara1986 opened this issue Oct 16, 2020 · 5 comments
Assignees
Labels
documentation Features and bugs of documentation good first issue Good for newcomers Hacktoberfest

Comments

@avara1986
Copy link
Member

Add to contributing this link https://chris.beams.io/posts/git-commit/

@alexppg
Copy link
Member

alexppg commented Oct 16, 2020

Maybe this is superseded by this, if you like it? #195

@avara1986
Copy link
Member Author

I like commitizen @alexppg but commitizen and this issue both are "recommendations" and can't be "impositions". Add the both ways are useful, what do you think? :)

@alexppg
Copy link
Member

alexppg commented Oct 16, 2020

Oh well, I see commitizen as a way to standarize the commits. It's not really useful if not everybody uses it, since you won't be able to use it's features.
So if commitizen won't be mandatory, I would just close the issue. This guide is pretty useful anyway!

@avara1986
Copy link
Member Author

No, no. Sorry, maybe i need to check and figure out commitizen. Do you can set commitizen as a mandatory way to commit new changes? I was thinking that is a tool to "help" when you commit anything, not a tool like black that force you to use this way of add changes

@alexppg
Copy link
Member

alexppg commented Oct 16, 2020

They do have a way to check that the commit follows the stipulated format with cz check. Also they have a pre-commit.

The way it works is that you create a configuration in the root of the project with the format you want and everybody just have to execute git cz and a interactive interface will appear asking questions.

It's not mandatory to use cz as is as long as your commit follows the format. I actually have it only as a git template, I don't use the interactive tool, for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Features and bugs of documentation good first issue Good for newcomers Hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants