Proposal to Update GitHub Documentation for Initial Commit Message #66302
Unanswered
juliankasimir
asked this question in
Repositories
Replies: 1 comment
-
I think if 'Initial commit' doesn't describe what we are committing, we can write in contribution guidelines that we discourage use of messages like 'Initial Commit', which doesn't say much about the contents of a commit. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Select Topic Area
Question
Body
I've noticed that GitHub suggests using 'initial commit' as the default message for the first commit in a new repository. However, I'm aware that not everyone uses or needs conventional commits, and I'm unsure if it's necessary in all cases.
I want to clarify that adding 'docs:' to the commit message doesn't impact the versioning process (semantic release). It's simply a way to provide more context and improve the clarity of commit messages, especially for documentation-related changes.
I would like to propose updating the GitHub documentation to encourage the use of more informative commit messages by default, like
docs: add README.md
(ordocs: add initial README.md
) without affecting versioning. This change could help maintainers and contributors who choose to adopt a structured approach while not imposing it on those who prefer a different style.What are your thoughts on this proposal, and how can we find a balance between providing flexibility and encouraging best practices?
Beta Was this translation helpful? Give feedback.
All reactions