From 0f09fb01eae1fdf1e393b09be0145ca7e6f0d3a1 Mon Sep 17 00:00:00 2001 From: Jason Self Date: Sun, 20 May 2018 08:37:13 -0700 Subject: [PATCH] Add guidelines for commit messages This helps to keep everyone on the same page. --- CONTRIBUTING | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING b/CONTRIBUTING index 18987c3..29e6473 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -28,6 +28,24 @@ message to the GNU Linux-libre mailing list: - Your patch must also update the root level Makefile to build the firmware, as appropriate. +Git Commit Messages +------------------- + +- Limit the subject to 50 characters. + +- Use proper capitalization and imperative mood in the subject. + +- Don't put a period at the end of the subject. + +- Small changes, like fixing a typo, can get by with only a subject. + Larger changes should include a body too. + +- Use a blank line to separate the subject and body. + +- Use the body to explain the what and why of the change. + +- Wrap the body at 70 characters. + Development & Release Process ----------------------------- -- 2.31.1