From 14ed97102b5bf14ebf5e830f1ddeb0a5dd9310e9 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Sat, 5 Aug 2017 11:44:51 +0200 Subject: [PATCH] Add instructions for developers --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1f4ee33a..33bf4c266 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,8 +129,14 @@ down to the following steps: next stable release. While writing, ask yourself: If I were the user, what would I need to be aware of with this change. - 8. Once your code looks good and passes all the tests, we'll merge it. Thanks - a low for your contribution! + 8. When your contribution adds and/or changes command-line parameters or help + texts, the manual pages need to be regenerated and commited to the + repository. In order to do this, compile restic and save the generated + updated man pages in the subdir `doc/man` with the following command: + `./restic manpages --output-dir doc/man` + + 9. Once your code looks good and passes all the tests, we'll merge it. Thanks + a lot for your contribution! Please provide the patches for each bug or feature in a separate branch and open up a pull request for each.