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

Write git message format/etiquette guide #21

Open
RandomSpaceship opened this issue Dec 19, 2024 · 4 comments
Open

Write git message format/etiquette guide #21

RandomSpaceship opened this issue Dec 19, 2024 · 4 comments
Assignees
Labels
02-documentation Improvements or additions to documentation 20-software General software issue, not specific to any one area

Comments

@RandomSpaceship
Copy link
Contributor

Having the Git messages in a (mostly) standard format makes it significantly easier to see what's changed at a glance.

@RandomSpaceship RandomSpaceship added 02-documentation Improvements or additions to documentation 20-software General software issue, not specific to any one area labels Dec 19, 2024
@RandomSpaceship
Copy link
Contributor Author

Thoughts:

Format: package or package(node), preferring, in order:

  • package(node): sensors(m2m2_lidar)
  • language(specification): nix(flake)
  • docs(section): docs(architecture)
  • chore

Each commit should be a small logical block, which always leaves the code in a working state.

@DingoOz
Copy link
Contributor

DingoOz commented Dec 22, 2024

+1 for calling this "gitiquette" or "commitiquette" :)

@DingoOz
Copy link
Contributor

DingoOz commented Dec 22, 2024

Point of style, should the comments after the colon start with a capital letter or lower case?

@RandomSpaceship
Copy link
Contributor Author

I don't really mind either way, but it probably should be uppercase if we're formalizing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
02-documentation Improvements or additions to documentation 20-software General software issue, not specific to any one area
Projects
None yet
Development

No branches or pull requests

2 participants