w3c / w3c/w3c.github.io

Recommend commit guidelines?

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

best practices enhancement question
Dominant language
HTML
Stars
148
Forks
41
Avg merge
1m
Merged PRs (30d)
7

Description

eg, Git commit guidelines.

There is some value already in converging in the format of commit messages alone.

But also, by doing that, we could at some point adopt tools that process and digest the commit history of a project to produce automated changelogs and/or decide the next semantic version to be published (eg, semantic-release).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Angular DEVELOPERS.md Git commit guidelines and the semantic-release project referenced in the issue. Determine whether this repository has an existing contributor or release-guidelines document to update; done means the desired commit format and any changelog or semantic-versioning expectations are explicitly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.