Skip to content
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

Commit conventions #4

Open
AsafFisher opened this issue Jan 29, 2021 · 4 comments
Open

Commit conventions #4

AsafFisher opened this issue Jan 29, 2021 · 4 comments

Comments

@AsafFisher
Copy link
Member

AsafFisher commented Jan 29, 2021

The commit conventions should be as follows:

project_component: module/file: comment

For example:

build: Travis.yml: Add new CI job

@devsnek
Copy link
Member

devsnek commented Jan 29, 2021

can the "module/file" bit be removed? commits already tell you which files have been modified right in the message.

@AsafFisher
Copy link
Member Author

AsafFisher commented Jan 29, 2021

Maybe the file but not the module.
For example:
OSX: arch: Implement ....

P.S. I don't work at apple.

@johnbatty
Copy link

I also think that module/file is unnecessary - the file path gives you that.
Better to use those chars for a good description of the change.

There's good advice on writing git commit messages here:
https://chris.beams.io/posts/git-commit/

@AsafFisher
Copy link
Member Author

AsafFisher commented Jan 30, 2021

The idea is to not need to do git log to understand the context of the commit.. That is why the module/file is necessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants