From 55aec445b1b8d09969edae91954970561757dee0 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Wed, 14 Jul 2021 11:18:44 +0200 Subject: [PATCH] CONTRIBUTING: Update commit message guidelines. --- CONTRIBUTING.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da11fdd..7bb4aed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,20 +20,23 @@ will actually be implemented. - Commit messages have a one-line subject, a blank line and a multiline body: - prefix: subject + prefix: Subject of the change. body... -- Use a prefix to categorize the change. Usually this is the path the the file - being changed. - - If it is a documentation change, it can be shortened to `doc/` (omit - `api` from the path). - - If it is an API change (in the `pybricks` folder), write `api/` - instead of `pybricks/`. -- The subject briefly describes _what_ was changed, e.g. `fix typo`. +- Use a prefix to categorize the change: + - Use the import path as the prefix whenever possible. Examples: + - pybricks.tools: Add StopWatch class. + - pybricks.tools: Reorganize RST files. + - pybricks.tools.StopWatch: Fix return type. + - pybricks.tools.wait: Add example of waiting. + - pybricks.pupdevices: Fix all sensor class ports. + - umath.sin: Fix spelling of Hypotenuse. + - If an import path makes no sense, just use the file path without extensions: + - .vscode/settings: Fix file associations. +- The subject briefly describes _what_ was changed. Use a short full sentence as in the examples above. - The body describes _why_ the change was made, e.g. `The word "sensor" was spelled incorrectly`. -- See the [commit history][commits] for more examples. [commits]: https://github.com/pybricks/pybricks-api/commits/master