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
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion specs.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@ <h1>Using GitHub for Spec Work</h1>
We can then add it to the repository.
</p>
<pre>git add index.html
git commit -m "Add empty doc."</pre>
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 :)

</li>
<li>
<p>
Expand Down