From 6ab1d81eda53f7fb0e7ba7d4f2c56d3289b760f2 Mon Sep 17 00:00:00 2001 From: Josh Triplett Date: Fri, 29 Jul 2016 21:06:32 -0700 Subject: [PATCH] README.md: Expand the explanation of `git series commit` --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 26e8f68e015c726b2d16ac807f9ad2b07f031463..b231937b3f37fdbeec5c0e76f06f1b9bf6ca42fc 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,15 @@ Getting started - Use `git series cover` to add or edit a cover letter. -- Use `git series add` and `git series commit` (or `git series commit -a`) to - commit changes to the patch series. - - Use `git series rebase -i` to help rework or reorganize the patch series. +- Use `git series add` and `git series commit` (or `git series commit -a`) to + commit changes to the patch series. You can do this whenever you've changed + the base or cover letter, or whenever you've changed HEAD to a new commit. + Make a series commit whenever you've made a semantic change to the patch + series that you want to record, such as rebasing on a new upstream version, + reorganizing patches, or incorporating feedback. + - Use `git series format` to prepare the patch series to send via email, or use `git series req` to prepare a "please pull" mail (after pushing the changes to a repository as a branch or tag).