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

Promote Git Commit Msg conventions #107

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

plehegar
Copy link
Member

@plehegar plehegar commented Jun 17, 2022

We should stir our community towards using Git Commit Msg conventions. This would facilitate the review of commit logs. Proposal is to start with Get Commit Msg.

git commit -m "chore: Add empty doc."</pre>
<p>
Tip: consider using the conventions <q><a href="http://karma-runner.github.io/1.0/dev/git-commit-msg.html">Git Commit Msg</a></q>.
</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM, but maybe link to repos that have already adopted these conventions for W3C spec work.

(also, if we want to promote it, documenting them is necessary but clearly not sufficient :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM, but maybe link to repos that have already adopted these conventions for W3C spec work.

done.

(also, if we want to promote it, documenting them is necessary but clearly not sufficient :)

Agreed. The first step is to update the documentation so that we can point to it while promoting. I'm currently promoting the pull request :)

@plehegar
Copy link
Member Author

Btw, there are 2 versions of the documentation: 1.0 and 6.4. I chose to stick with 1.0 since it contains 'chore:' while the updated version does not. Happy to debate.

specs.html Outdated Show resolved Hide resolved
@plehegar
Copy link
Member Author

#98 is likely related

@plehegar
Copy link
Member Author

@plehegar
Copy link
Member Author

@plehegar plehegar self-assigned this Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants