From da28658773e3e0139f48c60a4c516ad461d3947d Mon Sep 17 00:00:00 2001
From: Jocelyn Delalande <jocelyn@crapouillou.net>
Date: Sun, 25 Nov 2018 21:30:20 +0100
Subject: Document `make release` magic

I am a bit scared to use this magic command each time I have to. That is to
reassure future me and future others :-).
---
 docs/contributing.rst | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'docs')

diff --git a/docs/contributing.rst b/docs/contributing.rst
index 836dc08..1944d67 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -152,3 +152,7 @@ Once this is done, use the "release" instruction:
      $ make release
 
 And the new version should be published on PyPI.
+
+.. note:: The above command will prompt for version number, handle
+          :file:`CHANGELOG.rst` and :file:`setup.py` updates, package creation,
+          pypi upload. It will prompt you before each step to get your consent.
-- 
cgit v1.1