Commit message improvements

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Open the “Fixing a bug” page at developer.thunderbird.net and locate its “Commit messages” section. Add the proposed guidance and examples there, then verify the page clearly explains that commit messages describe the change rather than the bug and that the examples render correctly.

Written by the indexing model from the issue text.

Description

This may be buried somewhere on DTN, but I did not find it in the obvious place https://developer.thunderbird.net/thunderbird-development/fixing-a-bug#commit-messages.

A short paragraph like this would be helpful.

The commit message text should describe the change that was made rather than the bug it fixes.

Example:

  • Bug - Unable to use GPG smartcards on macOS
  • Bad commit message: Fix broken smartcards on macOS
  • Good commit message: Enable loading unsigned shared libraries on macOS
Dominant language
No language data
Stars
114
Forks
86
Avg merge
2h 37m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

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.

More from thunderbird/developer-docs

All issues in thunderbird/developer-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.