thunderbird / thunderbird/developer-docs
Commit message improvements
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 114
- Forks
- 86
- Avg merge
- 2h 37m
- Merged PRs (30d)
- 1
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100