From 2b10c34f5c95ed2fd0df4ea79556fcb7622d5651 Mon Sep 17 00:00:00 2001 From: Brian Gianforcaro Date: Sat, 22 May 2021 16:09:18 -0700 Subject: [PATCH] Meta: Clarify atomic commits in CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index affccb4828..c437c27b71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ Nobody is perfect, and sometimes we mess things up. That said, here are some goo * Write in idiomatic SerenityOS C++20, using the `AK` containers in all code. * Conform to the project coding style found in [CodingStyle.md](https://github.com/SerenityOS/serenity/blob/master/Documentation/CodingStyle.md). Use `clang-format` (version 11 or later) to automatically format C++ files. * Choose expressive variable, function and class names. Make it as obvious as possible what the code is doing. -* Split your changes into separate, atomic commits. +* Split your changes into separate, atomic commits (i.e. A commit per feature or fix, where the build, tests and the system are all functioning). * Make sure your commits are rebased on the master branch. * Wrap your commit messages at 72 characters. * The first line of the commit message is the subject line, and should have the format "Category: Brief description of what's being changed". The "category" can be a subdirectory, but also something like "POSIX compliance" or "ClassName". Whatever seems logical.